Skip to content

README.md

Latest commit

 

History

History
383 lines (340 loc) · 21.6 KB

README.md

File metadata and controls

383 lines (340 loc) · 21.6 KB

flightctl

Flight Control is a service for declarative management of fleets of edge devices and their workloads.

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

  • API version: v1beta1
  • Package version: 1.1.0
  • Generator version: 7.17.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://flightctl.io

Requirements.

Python 3.9+

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 /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = flightctl.Configuration(
    host = "/api/v1"
)



# 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.AuthenticationApi(api_client)

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

Documentation for API Endpoints

All URIs are relative to /api/v1

Class Method HTTP request Description
AuthenticationApi auth_config GET /auth/config
AuthenticationApi auth_get_permissions GET /auth/permissions
AuthenticationApi auth_token POST /auth/{providername}/token
AuthenticationApi auth_user_info GET /auth/userinfo
AuthenticationApi auth_validate GET /auth/validate
AuthproviderApi create_auth_provider POST /authproviders
AuthproviderApi delete_auth_provider DELETE /authproviders/{name}
AuthproviderApi get_auth_provider GET /authproviders/{name}
AuthproviderApi list_auth_providers GET /authproviders
AuthproviderApi patch_auth_provider PATCH /authproviders/{name}
AuthproviderApi replace_auth_provider PUT /authproviders/{name}
CertificatesigningrequestApi create_certificate_signing_request POST /certificatesigningrequests
CertificatesigningrequestApi delete_certificate_signing_request DELETE /certificatesigningrequests/{name}
CertificatesigningrequestApi get_certificate_signing_request GET /certificatesigningrequests/{name}
CertificatesigningrequestApi list_certificate_signing_requests GET /certificatesigningrequests
CertificatesigningrequestApi patch_certificate_signing_request PATCH /certificatesigningrequests/{name}
CertificatesigningrequestApi replace_certificate_signing_request PUT /certificatesigningrequests/{name}
CertificatesigningrequestApi update_certificate_signing_request_approval PUT /certificatesigningrequests/{name}/approval
DeviceApi create_device POST /devices
DeviceApi decommission_device PUT /devices/{name}/decommission
DeviceApi delete_device DELETE /devices/{name}
DeviceApi get_device GET /devices/{name}
DeviceApi get_device_last_seen GET /devices/{name}/lastseen
DeviceApi get_device_status GET /devices/{name}/status
DeviceApi get_rendered_device GET /devices/{name}/rendered
DeviceApi list_devices GET /devices
DeviceApi patch_device PATCH /devices/{name}
DeviceApi patch_device_status PATCH /devices/{name}/status
DeviceApi replace_device PUT /devices/{name}
DeviceApi replace_device_status PUT /devices/{name}/status
DeviceactionsApi resume_devices POST /deviceactions/resume
EnrollmentrequestApi approve_enrollment_request PUT /enrollmentrequests/{name}/approval
EnrollmentrequestApi create_enrollment_request POST /enrollmentrequests
EnrollmentrequestApi delete_enrollment_request DELETE /enrollmentrequests/{name}
EnrollmentrequestApi get_enrollment_config GET /enrollmentconfig
EnrollmentrequestApi get_enrollment_request GET /enrollmentrequests/{name}
EnrollmentrequestApi get_enrollment_request_status GET /enrollmentrequests/{name}/status
EnrollmentrequestApi list_enrollment_requests GET /enrollmentrequests
EnrollmentrequestApi patch_enrollment_request PATCH /enrollmentrequests/{name}
EnrollmentrequestApi patch_enrollment_request_status PATCH /enrollmentrequests/{name}/status
EnrollmentrequestApi replace_enrollment_request PUT /enrollmentrequests/{name}
EnrollmentrequestApi replace_enrollment_request_status PUT /enrollmentrequests/{name}/status
EventApi list_events GET /events
FleetApi create_fleet POST /fleets
FleetApi delete_fleet DELETE /fleets/{name}
FleetApi delete_template_version DELETE /fleets/{fleet}/templateversions/{name}
FleetApi get_fleet GET /fleets/{name}
FleetApi get_fleet_status GET /fleets/{name}/status
FleetApi get_template_version GET /fleets/{fleet}/templateversions/{name}
FleetApi list_fleets GET /fleets
FleetApi list_template_versions GET /fleets/{fleet}/templateversions
FleetApi patch_fleet PATCH /fleets/{name}
FleetApi patch_fleet_status PATCH /fleets/{name}/status
FleetApi replace_fleet PUT /fleets/{name}
FleetApi replace_fleet_status PUT /fleets/{name}/status
LabelApi list_labels GET /labels
OrganizationApi list_organizations GET /organizations List organizations
RepositoryApi create_repository POST /repositories
RepositoryApi delete_repository DELETE /repositories/{name}
RepositoryApi get_repository GET /repositories/{name}
RepositoryApi list_repositories GET /repositories
RepositoryApi patch_repository PATCH /repositories/{name}
RepositoryApi replace_repository PUT /repositories/{name}
ResourcesyncApi create_resource_sync POST /resourcesyncs
ResourcesyncApi delete_resource_sync DELETE /resourcesyncs/{name}
ResourcesyncApi get_resource_sync GET /resourcesyncs/{name}
ResourcesyncApi list_resource_syncs GET /resourcesyncs
ResourcesyncApi patch_resource_sync PATCH /resourcesyncs/{name}
ResourcesyncApi replace_resource_sync PUT /resourcesyncs/{name}
VersionApi get_version GET /version

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)

orgId

  • Type: API key
  • API key parameter name: org_id
  • Location: URL query string

Author

team@flightctl.io