Skip to content

flightctl/flightctl-python-client

BranchesTags

Repository files navigation

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: v1alpha1
  • Package version: 1.0.0
  • Generator version: 7.11.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://flightctl.io

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.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 http://localhost

Class Method HTTP request Description
AuthenticationApi auth_config GET /api/v1/auth/config
AuthenticationApi auth_validate GET /api/v1/auth/validate
CertificatesigningrequestApi create_certificate_signing_request POST /api/v1/certificatesigningrequests
CertificatesigningrequestApi delete_certificate_signing_request DELETE /api/v1/certificatesigningrequests/{name}
CertificatesigningrequestApi get_certificate_signing_request GET /api/v1/certificatesigningrequests/{name}
CertificatesigningrequestApi list_certificate_signing_requests GET /api/v1/certificatesigningrequests
CertificatesigningrequestApi patch_certificate_signing_request PATCH /api/v1/certificatesigningrequests/{name}
CertificatesigningrequestApi replace_certificate_signing_request PUT /api/v1/certificatesigningrequests/{name}
CertificatesigningrequestApi update_certificate_signing_request_approval PUT /api/v1/certificatesigningrequests/{name}/approval
DeviceApi create_device POST /api/v1/devices
DeviceApi decommission_device PUT /api/v1/devices/{name}/decommission
DeviceApi delete_device DELETE /api/v1/devices/{name}
DeviceApi get_device GET /api/v1/devices/{name}
DeviceApi get_device_status GET /api/v1/devices/{name}/status
DeviceApi get_rendered_device GET /api/v1/devices/{name}/rendered
DeviceApi list_devices GET /api/v1/devices
DeviceApi patch_device PATCH /api/v1/devices/{name}
DeviceApi patch_device_status PATCH /api/v1/devices/{name}/status
DeviceApi replace_device PUT /api/v1/devices/{name}
DeviceApi replace_device_status PUT /api/v1/devices/{name}/status
EnrollmentrequestApi approve_enrollment_request PUT /api/v1/enrollmentrequests/{name}/approval
EnrollmentrequestApi create_enrollment_request POST /api/v1/enrollmentrequests
EnrollmentrequestApi delete_enrollment_request DELETE /api/v1/enrollmentrequests/{name}
EnrollmentrequestApi get_enrollment_config GET /api/v1/enrollmentconfig
EnrollmentrequestApi get_enrollment_request GET /api/v1/enrollmentrequests/{name}
EnrollmentrequestApi get_enrollment_request_status GET /api/v1/enrollmentrequests/{name}/status
EnrollmentrequestApi list_enrollment_requests GET /api/v1/enrollmentrequests
EnrollmentrequestApi patch_enrollment_request PATCH /api/v1/enrollmentrequests/{name}
EnrollmentrequestApi patch_enrollment_request_status PATCH /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
EventApi list_events GET /api/v1/events
FleetApi create_fleet POST /api/v1/fleets
FleetApi delete_fleet DELETE /api/v1/fleets/{name}
FleetApi delete_template_version DELETE /api/v1/fleets/{fleet}/templateversions/{name}
FleetApi get_fleet GET /api/v1/fleets/{name}
FleetApi get_fleet_status GET /api/v1/fleets/{name}/status
FleetApi get_template_version GET /api/v1/fleets/{fleet}/templateversions/{name}
FleetApi list_fleets GET /api/v1/fleets
FleetApi list_template_versions GET /api/v1/fleets/{fleet}/templateversions
FleetApi patch_fleet PATCH /api/v1/fleets/{name}
FleetApi patch_fleet_status PATCH /api/v1/fleets/{name}/status
FleetApi replace_fleet PUT /api/v1/fleets/{name}
FleetApi replace_fleet_status PUT /api/v1/fleets/{name}/status
LabelApi list_labels GET /api/v1/labels
OrganizationApi list_organizations GET /api/v1/organizations List organizations
RepositoryApi create_repository POST /api/v1/repositories
RepositoryApi delete_repository DELETE /api/v1/repositories/{name}
RepositoryApi get_repository GET /api/v1/repositories/{name}
RepositoryApi list_repositories GET /api/v1/repositories
RepositoryApi patch_repository PATCH /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 get_resource_sync GET /api/v1/resourcesyncs/{name}
ResourcesyncApi list_resource_syncs GET /api/v1/resourcesyncs
ResourcesyncApi patch_resource_sync PATCH /api/v1/resourcesyncs/{name}
ResourcesyncApi replace_resource_sync PUT /api/v1/resourcesyncs/{name}
VersionApi get_version GET /api/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

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

5 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages