flightctl

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: undefined
• Package version: 1.0.0
• Generator version: 7.10.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/flightctl/python-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/flightctl/python-client.git)

Then import the package:

import flightctl

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import flightctl

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import flightctl
from flightctl.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flightctl.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with flightctl.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = flightctl.CertificatesigningrequestApi(api_client)
    certificate_signing_request = flightctl.CertificateSigningRequest() # CertificateSigningRequest | 

    try:
        api_response = api_instance.create_certificate_signing_request(certificate_signing_request)
        print("The response of CertificatesigningrequestApi->create_certificate_signing_request:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CertificatesigningrequestApi->create_certificate_signing_request: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
CertificatesigningrequestApi	create_certificate_signing_request	POST /api/v1/certificatesigningrequests
CertificatesigningrequestApi	delete_certificate_signing_request	DELETE /api/v1/certificatesigningrequests/{name}
CertificatesigningrequestApi	delete_certificate_signing_requests	DELETE /api/v1/certificatesigningrequests
CertificatesigningrequestApi	list_certificate_signing_requests	GET /api/v1/certificatesigningrequests
CertificatesigningrequestApi	patch_certificate_signing_request	PATCH /api/v1/certificatesigningrequests/{name}
CertificatesigningrequestApi	read_certificate_signing_request	GET /api/v1/certificatesigningrequests/{name}
CertificatesigningrequestApi	replace_certificate_signing_request	PUT /api/v1/certificatesigningrequests/{name}
DefaultApi	approve_certificate_signing_request	POST /api/v1/certificatesigningrequests/{name}/approval
DefaultApi	auth_config	GET /api/v1/auth/config
DefaultApi	auth_validate	GET /api/v1/auth/validate
DefaultApi	deny_certificate_signing_request	DELETE /api/v1/certificatesigningrequests/{name}/approval
DeviceApi	create_device	POST /api/v1/devices
DeviceApi	delete_device	DELETE /api/v1/devices/{name}
DeviceApi	delete_devices	DELETE /api/v1/devices
DeviceApi	get_rendered_device_spec	GET /api/v1/devices/{name}/rendered
DeviceApi	list_devices	GET /api/v1/devices
DeviceApi	patch_device	PATCH /api/v1/devices/{name}
DeviceApi	read_device	GET /api/v1/devices/{name}
DeviceApi	read_device_status	GET /api/v1/devices/{name}/status
DeviceApi	replace_device	PUT /api/v1/devices/{name}
DeviceApi	replace_device_status	PUT /api/v1/devices/{name}/status
DeviceApi	request_console	GET /api/v1/devices/{name}/console
EnrollmentconfigApi	enrollment_config	GET /api/v1/enrollmentconfig/{name}
EnrollmentrequestApi	approve_enrollment_request	POST /api/v1/enrollmentrequests/{name}/approval
EnrollmentrequestApi	create_enrollment_request	POST /api/v1/enrollmentrequests
EnrollmentrequestApi	delete_enrollment_request	DELETE /api/v1/enrollmentrequests/{name}
EnrollmentrequestApi	delete_enrollment_requests	DELETE /api/v1/enrollmentrequests
EnrollmentrequestApi	list_enrollment_requests	GET /api/v1/enrollmentrequests
EnrollmentrequestApi	read_enrollment_request	GET /api/v1/enrollmentrequests/{name}
EnrollmentrequestApi	read_enrollment_request_status	GET /api/v1/enrollmentrequests/{name}/status
EnrollmentrequestApi	replace_enrollment_request	PUT /api/v1/enrollmentrequests/{name}
EnrollmentrequestApi	replace_enrollment_request_status	PUT /api/v1/enrollmentrequests/{name}/status
FleetApi	create_fleet	POST /api/v1/fleets
FleetApi	delete_fleet	DELETE /api/v1/fleets/{name}
FleetApi	delete_fleets	DELETE /api/v1/fleets
FleetApi	list_fleets	GET /api/v1/fleets
FleetApi	patch_fleet	PATCH /api/v1/fleets/{name}
FleetApi	read_fleet	GET /api/v1/fleets/{name}
FleetApi	read_fleet_status	GET /api/v1/fleets/{name}/status
FleetApi	replace_fleet	PUT /api/v1/fleets/{name}
FleetApi	replace_fleet_status	PUT /api/v1/fleets/{name}/status
RepositoryApi	create_repository	POST /api/v1/repositories
RepositoryApi	delete_repositories	DELETE /api/v1/repositories
RepositoryApi	delete_repository	DELETE /api/v1/repositories/{name}
RepositoryApi	list_repositories	GET /api/v1/repositories
RepositoryApi	patch_repository	PATCH /api/v1/repositories/{name}
RepositoryApi	read_repository	GET /api/v1/repositories/{name}
RepositoryApi	replace_repository	PUT /api/v1/repositories/{name}
ResourcesyncApi	create_resource_sync	POST /api/v1/resourcesyncs
ResourcesyncApi	delete_resource_sync	DELETE /api/v1/resourcesyncs/{name}
ResourcesyncApi	delete_resource_syncs	DELETE /api/v1/resourcesyncs
ResourcesyncApi	list_resource_sync	GET /api/v1/resourcesyncs
ResourcesyncApi	patch_resource_sync	PATCH /api/v1/resourcesyncs/{name}
ResourcesyncApi	read_resource_sync	GET /api/v1/resourcesyncs/{name}
ResourcesyncApi	replace_resource_sync	PUT /api/v1/resourcesyncs/{name}
TemplateversionApi	delete_template_version	DELETE /api/v1/fleets/{fleet}/templateversions/{name}
TemplateversionApi	delete_template_versions	DELETE /api/v1/fleets/{fleet}/templateversions
TemplateversionApi	list_template_versions	GET /api/v1/fleets/{fleet}/templateversions
TemplateversionApi	read_template_version	GET /api/v1/fleets/{fleet}/templateversions/{name}

Documentation For Models

• ApplicationEnvVars
• ApplicationSpec
• ApplicationStatusType
• ApplicationsSummaryStatusType
• AuthConfig
• Batch
• BatchLimit
• BatchSequence
• CPUResourceMonitorSpec
• CertificateSigningRequest
• CertificateSigningRequestList
• CertificateSigningRequestSpec
• CertificateSigningRequestStatus
• Condition
• ConditionStatus
• ConditionType
• ConfigProviderSpec
• CustomResourceMonitorSpec
• Device
• DeviceApplicationStatus
• DeviceApplicationsSummaryStatus
• DeviceConfigStatus
• DeviceConsole
• DeviceHooksSpec
• DeviceIntegrityStatus
• DeviceIntegrityStatusSummary
• DeviceIntegrityStatusSummaryType
• DeviceList
• DeviceOSSpec
• DeviceOSStatus
• DeviceRebootHookSpec
• DeviceResourceStatus
• DeviceResourceStatusType
• DeviceSpec
• DeviceSpecSystemd
• DeviceStatus
• DeviceSummaryStatus
• DeviceSummaryStatusType
• DeviceSystemInfo
• DeviceUpdateHookSpec
• DeviceUpdatedStatus
• DeviceUpdatedStatusType
• DevicesSummary
• DiskResourceMonitorSpec
• DisruptionAllowance
• EnrollmentConfig
• EnrollmentRequest
• EnrollmentRequestApproval
• EnrollmentRequestList
• EnrollmentRequestSpec
• EnrollmentRequestStatus
• EnrollmentService
• EnrollmentServiceAuth
• EnrollmentServiceService
• Error
• FileOperation
• FileSpec
• Fleet
• FleetList
• FleetRolloutStatus
• FleetSpec
• FleetSpecTemplate
• FleetStatus
• GenericRepoSpec
• GitConfigProviderSpec
• GitConfigProviderSpecGitRef
• HookAction
• HookActionExecutable
• HookActionExecutableSpec
• HookActionOneOf
• HookActionOneOf1
• HookActionSpec
• HookActionSystemdSpec
• HookActionSystemdUnit
• HttpConfig
• HttpConfigProviderSpec
• HttpConfigProviderSpecHttpRef
• HttpRepoSpec
• ImageApplicationProvider
• InlineConfigProviderSpec
• KubernetesSecretProviderSpec
• KubernetesSecretProviderSpecSecretRef
• LabelSelector
• ListMeta
• MatchExpression
• MemoryResourceMonitorSpec
• ObjectMeta
• PatchRequestInner
• RenderedApplicationSpec
• RenderedDeviceSpec
• RenderedDeviceSpecSystemd
• RepoSpecType
• Repository
• RepositoryList
• RepositorySpec
• RepositoryStatus
• ResourceAlertRule
• ResourceAlertSeverityType
• ResourceMonitor
• ResourceMonitorSpec
• ResourceSync
• ResourceSyncList
• ResourceSyncSpec
• ResourceSyncStatus
• RolloutDeviceSelection
• RolloutPolicy
• SortOrder
• SshConfig
• SshRepoSpec
• Status
• TemplateVersion
• TemplateVersionList
• TemplateVersionSpec
• TemplateVersionStatus

Documentation For Authorization

Endpoints do not require authorization.

Author