flightctl.FleetApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_fleet	POST /api/v1/fleets
delete_fleet	DELETE /api/v1/fleets/{name}
delete_template_version	DELETE /api/v1/fleets/{fleet}/templateversions/{name}
get_fleet	GET /api/v1/fleets/{name}
get_fleet_status	GET /api/v1/fleets/{name}/status
get_template_version	GET /api/v1/fleets/{fleet}/templateversions/{name}
list_fleets	GET /api/v1/fleets
list_template_versions	GET /api/v1/fleets/{fleet}/templateversions
patch_fleet	PATCH /api/v1/fleets/{name}
patch_fleet_status	PATCH /api/v1/fleets/{name}/status
replace_fleet	PUT /api/v1/fleets/{name}
replace_fleet_status	PUT /api/v1/fleets/{name}/status

create_fleet

Fleet create_fleet(fleet)

Create a Fleet resource.

Example

import flightctl
from flightctl.models.fleet import Fleet
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.FleetApi(api_client)
    fleet = flightctl.Fleet() # Fleet | 

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

Parameters

Name	Type	Description	Notes
fleet	Fleet

Return type

Fleet

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
409	Conflict	-
429	Too Many Requests	-
503	Service Unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_fleet

Status delete_fleet(name)

Delete a Fleet resource.

Example

import flightctl
from flightctl.models.status import Status
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.FleetApi(api_client)
    name = 'name_example' # str | The name of the Fleet resource to delete.

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

Parameters

Name	Type	Description	Notes
name	str	The name of the Fleet resource to delete.

Return type

Status

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-
503	Service Unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_template_version

Status delete_template_version(fleet, name)

delete a template version

Example

import flightctl
from flightctl.models.status import Status
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.FleetApi(api_client)
    fleet = 'fleet_example' # str | The owner of the template version.
    name = 'name_example' # str | The name of the template version.

    try:
        api_response = api_instance.delete_template_version(fleet, name)
        print("The response of FleetApi->delete_template_version:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FleetApi->delete_template_version: %s\n" % e)

Parameters

Name	Type	Description	Notes
fleet	str	The owner of the template version.
name	str	The name of the template version.

Return type

Status

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-
503	Service Unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_fleet

Fleet get_fleet(name, add_devices_summary=add_devices_summary)

Get a Fleet resource.

Example

import flightctl
from flightctl.models.fleet import Fleet
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.FleetApi(api_client)
    name = 'name_example' # str | The name of the Fleet resource to get.
    add_devices_summary = True # bool | Include a summary of the devices in the fleet. (optional)

    try:
        api_response = api_instance.get_fleet(name, add_devices_summary=add_devices_summary)
        print("The response of FleetApi->get_fleet:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FleetApi->get_fleet: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	The name of the Fleet resource to get.
add_devices_summary	bool	Include a summary of the devices in the fleet.	[optional]

Return type

Fleet

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-
503	Service Unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_fleet_status

Fleet get_fleet_status(name)

read status of the specified Fleet

Example

import flightctl
from flightctl.models.fleet import Fleet
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.FleetApi(api_client)
    name = 'name_example' # str | The name of the Fleet resource to get.

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

Parameters

Name	Type	Description	Notes
name	str	The name of the Fleet resource to get.

Return type

Fleet

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-
503	Service Unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_template_version

TemplateVersion get_template_version(fleet, name)

read the specified template version

Example

import flightctl
from flightctl.models.template_version import TemplateVersion
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.FleetApi(api_client)
    fleet = 'fleet_example' # str | The owner of the template version.
    name = 'name_example' # str | The name of the template version.

    try:
        api_response = api_instance.get_template_version(fleet, name)
        print("The response of FleetApi->get_template_version:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FleetApi->get_template_version: %s\n" % e)

Parameters

Name	Type	Description	Notes
fleet	str	The owner of the template version.
name	str	The name of the template version.

Return type

TemplateVersion

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-
503	Service Unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_fleets

FleetList list_fleets(var_continue=var_continue, label_selector=label_selector, field_selector=field_selector, limit=limit, add_devices_summary=add_devices_summary)

List Fleet resources.

Example

import flightctl
from flightctl.models.fleet_list import FleetList
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.FleetApi(api_client)
    var_continue = 'var_continue_example' # str | An optional parameter to query more results from the server. The value of the paramter must match the value of the 'continue' field in the previous list response. (optional)
    label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
    field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., \"key1=value1,key2!=value2\"). (optional)
    limit = 56 # int | The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query. (optional)
    add_devices_summary = True # bool | Include a summary of the devices in the fleet. (optional)

    try:
        api_response = api_instance.list_fleets(var_continue=var_continue, label_selector=label_selector, field_selector=field_selector, limit=limit, add_devices_summary=add_devices_summary)
        print("The response of FleetApi->list_fleets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FleetApi->list_fleets: %s\n" % e)

Parameters

Name	Type	Description	Notes
var_continue	str	An optional parameter to query more results from the server. The value of the paramter must match the value of the 'continue' field in the previous list response.	[optional]
label_selector	str	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
field_selector	str	A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2").	[optional]
limit	int	The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query.	[optional]
add_devices_summary	bool	Include a summary of the devices in the fleet.	[optional]

Return type

FleetList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
429	Too Many Requests	-
503	Service Unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_template_versions

TemplateVersionList list_template_versions(fleet, var_continue=var_continue, label_selector=label_selector, field_selector=field_selector, limit=limit)

list template versions

Example

import flightctl
from flightctl.models.template_version_list import TemplateVersionList
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.FleetApi(api_client)
    fleet = 'fleet_example' # str | The owner of the template versions.
    var_continue = 'var_continue_example' # str | An optional parameter to query more results from the server. The value of the paramter must match the value of the 'continue' field in the previous list response. (optional)
    label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
    field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., \"key1=value1,key2!=value2\"). (optional)
    limit = 56 # int | The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query. (optional)

    try:
        api_response = api_instance.list_template_versions(fleet, var_continue=var_continue, label_selector=label_selector, field_selector=field_selector, limit=limit)
        print("The response of FleetApi->list_template_versions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FleetApi->list_template_versions: %s\n" % e)

Parameters

Name	Type	Description	Notes
fleet	str	The owner of the template versions.
var_continue	str	An optional parameter to query more results from the server. The value of the paramter must match the value of the 'continue' field in the previous list response.	[optional]
label_selector	str	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
field_selector	str	A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2").	[optional]
limit	int	The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query.	[optional]

Return type

TemplateVersionList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
429	Too Many Requests	-
503	Service Unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_fleet

Fleet patch_fleet(name, patch_request_inner)

Patch a Fleet resource.

Example

import flightctl
from flightctl.models.fleet import Fleet
from flightctl.models.patch_request_inner import PatchRequestInner
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.FleetApi(api_client)
    name = 'name_example' # str | The name of the Fleet resource to patch.
    patch_request_inner = [flightctl.PatchRequestInner()] # List[PatchRequestInner] | 

    try:
        api_response = api_instance.patch_fleet(name, patch_request_inner)
        print("The response of FleetApi->patch_fleet:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FleetApi->patch_fleet: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	The name of the Fleet resource to patch.
patch_request_inner	List[PatchRequestInner]

Return type

Fleet

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
429	Too Many Requests	-
503	Service Unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_fleet_status

Fleet patch_fleet_status(name, patch_request_inner)

Patch the status of a Fleet resource.

Example

import flightctl
from flightctl.models.fleet import Fleet
from flightctl.models.patch_request_inner import PatchRequestInner
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.FleetApi(api_client)
    name = 'name_example' # str | The name of the Fleet resource to patch.
    patch_request_inner = [flightctl.PatchRequestInner()] # List[PatchRequestInner] | 

    try:
        api_response = api_instance.patch_fleet_status(name, patch_request_inner)
        print("The response of FleetApi->patch_fleet_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FleetApi->patch_fleet_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	The name of the Fleet resource to patch.
patch_request_inner	List[PatchRequestInner]

Return type

Fleet

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-
503	Service Unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replace_fleet

Fleet replace_fleet(name, fleet)

Update a Fleet resource.

Example

import flightctl
from flightctl.models.fleet import Fleet
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.FleetApi(api_client)
    name = 'name_example' # str | The name of the Fleet resource to update.
    fleet = flightctl.Fleet() # Fleet | 

    try:
        api_response = api_instance.replace_fleet(name, fleet)
        print("The response of FleetApi->replace_fleet:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FleetApi->replace_fleet: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	The name of the Fleet resource to update.
fleet	Fleet

Return type

Fleet

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
201	Created	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
403	Forbidden	-
409	Conflict	-
429	Too Many Requests	-
503	Service Unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replace_fleet_status

Fleet replace_fleet_status(name, fleet)

replace status of the specified Fleet

Example

import flightctl
from flightctl.models.fleet import Fleet
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.FleetApi(api_client)
    name = 'name_example' # str | The name of the Fleet resource to update.
    fleet = flightctl.Fleet() # Fleet | 

    try:
        api_response = api_instance.replace_fleet_status(name, fleet)
        print("The response of FleetApi->replace_fleet_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FleetApi->replace_fleet_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	The name of the Fleet resource to update.
fleet	Fleet

Return type

Fleet

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-
503	Service Unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

FleetApi.md

Latest commit

History

FleetApi.md

File metadata and controls

flightctl.FleetApi

create_fleet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_fleet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_template_version

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_fleet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_fleet_status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_template_version

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_fleets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_template_versions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_fleet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_fleet_status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

replace_fleet

Example

Parameters