signadot_sdk.api package

Submodules

signadot_sdk.api.cluster_api module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.api.cluster_api.ClusterApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

add_cluster(org_name, cluster_name, **kwargs)

Add a cluster # noqa: E501

Add a Kubernetes cluster to Signadot. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_cluster(org_name, cluster_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :return: Cluster

If the method is called asynchronously, returns the request thread.

add_cluster_with_http_info(org_name, cluster_name, **kwargs)

Add a cluster # noqa: E501

Add a Kubernetes cluster to Signadot. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_cluster_with_http_info(org_name, cluster_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :return: Cluster

If the method is called asynchronously, returns the request thread.

create_cluster_token(org_name, cluster_name, **kwargs)

Create cluster token # noqa: E501

Create a new token for connecting a cluster. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_cluster_token(org_name, cluster_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :return: ClusterToken

If the method is called asynchronously, returns the request thread.

create_cluster_token_with_http_info(org_name, cluster_name, **kwargs)

Create cluster token # noqa: E501

Create a new token for connecting a cluster. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_cluster_token_with_http_info(org_name, cluster_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :return: ClusterToken

If the method is called asynchronously, returns the request thread.

delete_cluster_token(org_name, cluster_name, token_id, **kwargs)

Delete cluster token # noqa: E501

Delete a cluster token associated with a cluster. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_cluster_token(org_name, cluster_name, token_id, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :param str token_id: Token Id (required) :return: EmptyResponse

If the method is called asynchronously, returns the request thread.

delete_cluster_token_with_http_info(org_name, cluster_name, token_id, **kwargs)

Delete cluster token # noqa: E501

Delete a cluster token associated with a cluster. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_cluster_token_with_http_info(org_name, cluster_name, token_id, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :param str token_id: Token Id (required) :return: EmptyResponse

If the method is called asynchronously, returns the request thread.

get_cluster(org_name, cluster_name, **kwargs)

Get a cluster # noqa: E501

Get a cluster. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_cluster(org_name, cluster_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :return: Cluster

If the method is called asynchronously, returns the request thread.

get_cluster_token(org_name, cluster_name, token_id, **kwargs)

Get a cluster token # noqa: E501

Get a cluster token associated with a cluster. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_cluster_token(org_name, cluster_name, token_id, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :param str token_id: Token Id (required) :return: ClusterToken

If the method is called asynchronously, returns the request thread.

get_cluster_token_with_http_info(org_name, cluster_name, token_id, **kwargs)

Get a cluster token # noqa: E501

Get a cluster token associated with a cluster. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_cluster_token_with_http_info(org_name, cluster_name, token_id, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :param str token_id: Token Id (required) :return: ClusterToken

If the method is called asynchronously, returns the request thread.

get_cluster_with_http_info(org_name, cluster_name, **kwargs)

Get a cluster # noqa: E501

Get a cluster. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_cluster_with_http_info(org_name, cluster_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :return: Cluster

If the method is called asynchronously, returns the request thread.

list_cluster_tokens(org_name, cluster_name, **kwargs)

List cluster tokens # noqa: E501

List the cluster tokens associated with a cluster. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_cluster_tokens(org_name, cluster_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :return: list[ClusterToken]

If the method is called asynchronously, returns the request thread.

list_cluster_tokens_with_http_info(org_name, cluster_name, **kwargs)

List cluster tokens # noqa: E501

List the cluster tokens associated with a cluster. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_cluster_tokens_with_http_info(org_name, cluster_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :return: list[ClusterToken]

If the method is called asynchronously, returns the request thread.

list_clusters(org_name, **kwargs)

List clusters # noqa: E501

List clusters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_clusters(org_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :return: list[Cluster]

If the method is called asynchronously, returns the request thread.

list_clusters_with_http_info(org_name, **kwargs)

List clusters # noqa: E501

List clusters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_clusters_with_http_info(org_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :return: list[Cluster]

If the method is called asynchronously, returns the request thread.

remove_cluster(org_name, cluster_name, **kwargs)

Remove a cluster # noqa: E501

Remove a Kubernetes cluster from Signadot. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.remove_cluster(org_name, cluster_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :return: EmptyResponse

If the method is called asynchronously, returns the request thread.

remove_cluster_with_http_info(org_name, cluster_name, **kwargs)

Remove a cluster # noqa: E501

Remove a Kubernetes cluster from Signadot. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.remove_cluster_with_http_info(org_name, cluster_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str cluster_name: Cluster Name (required) :return: EmptyResponse

If the method is called asynchronously, returns the request thread.

signadot_sdk.api.route_groups_api module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.api.route_groups_api.RouteGroupsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

apply_routegroup(org_name, routegroup_name, data, **kwargs)

Create or update a routegroup # noqa: E501

Creates or updates a routegroup with the provided parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.apply_routegroup(org_name, routegroup_name, data, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str routegroup_name: RouteGroup Name (required) :param RouteGroup data: Request to create or update routegroup (required) :return: RouteGroup

If the method is called asynchronously, returns the request thread.

apply_routegroup_with_http_info(org_name, routegroup_name, data, **kwargs)

Create or update a routegroup # noqa: E501

Creates or updates a routegroup with the provided parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.apply_routegroup_with_http_info(org_name, routegroup_name, data, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str routegroup_name: RouteGroup Name (required) :param RouteGroup data: Request to create or update routegroup (required) :return: RouteGroup

If the method is called asynchronously, returns the request thread.

delete_routegroup(org_name, routegroup_name, **kwargs)

Delete a routegroup # noqa: E501

Delete a given routegroup. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_routegroup(org_name, routegroup_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str routegroup_name: RouteGroup Name (required) :return: EmptyResponse

If the method is called asynchronously, returns the request thread.

delete_routegroup_with_http_info(org_name, routegroup_name, **kwargs)

Delete a routegroup # noqa: E501

Delete a given routegroup. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_routegroup_with_http_info(org_name, routegroup_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str routegroup_name: RouteGroup Name (required) :return: EmptyResponse

If the method is called asynchronously, returns the request thread.

get_routegroup(org_name, routegroup_name, **kwargs)

Get a routegroup # noqa: E501

Fetch the details about a given routegroup. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_routegroup(org_name, routegroup_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str routegroup_name: RouteGroup Name (required) :return: RouteGroup

If the method is called asynchronously, returns the request thread.

get_routegroup_with_http_info(org_name, routegroup_name, **kwargs)

Get a routegroup # noqa: E501

Fetch the details about a given routegroup. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_routegroup_with_http_info(org_name, routegroup_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str routegroup_name: RouteGroup Name (required) :return: RouteGroup

If the method is called asynchronously, returns the request thread.

list_routegroups(org_name, **kwargs)

List routegroups # noqa: E501

List all routegroups under the specified Signadot org. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_routegroups(org_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :return: list[RouteGroup]

If the method is called asynchronously, returns the request thread.

list_routegroups_with_http_info(org_name, **kwargs)

List routegroups # noqa: E501

List all routegroups under the specified Signadot org. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_routegroups_with_http_info(org_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :return: list[RouteGroup]

If the method is called asynchronously, returns the request thread.

signadot_sdk.api.sandboxes_api module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.api.sandboxes_api.SandboxesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

apply_sandbox(org_name, sandbox_name, data, **kwargs)

Create or update a sandbox # noqa: E501

Creates or updates a sandbox with the provided parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.apply_sandbox(org_name, sandbox_name, data, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str sandbox_name: Sandbox Name (required) :param Sandbox data: Request to create sandbox (required) :return: Sandbox

If the method is called asynchronously, returns the request thread.

apply_sandbox_with_http_info(org_name, sandbox_name, data, **kwargs)

Create or update a sandbox # noqa: E501

Creates or updates a sandbox with the provided parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.apply_sandbox_with_http_info(org_name, sandbox_name, data, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str sandbox_name: Sandbox Name (required) :param Sandbox data: Request to create sandbox (required) :return: Sandbox

If the method is called asynchronously, returns the request thread.

delete_sandbox(org_name, sandbox_name, **kwargs)

Delete a sandbox # noqa: E501

Delete a given sandbox. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_sandbox(org_name, sandbox_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str sandbox_name: Sandbox Name (required) :param bool force: force :return: EmptyResponse

If the method is called asynchronously, returns the request thread.

delete_sandbox_with_http_info(org_name, sandbox_name, **kwargs)

Delete a sandbox # noqa: E501

Delete a given sandbox. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_sandbox_with_http_info(org_name, sandbox_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str sandbox_name: Sandbox Name (required) :param bool force: force :return: EmptyResponse

If the method is called asynchronously, returns the request thread.

get_sandbox(org_name, sandbox_name, **kwargs)

Get a sandbox # noqa: E501

Fetch the details about a given sandbox. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_sandbox(org_name, sandbox_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str sandbox_name: Sandbox Name (required) :return: Sandbox

If the method is called asynchronously, returns the request thread.

get_sandbox_with_http_info(org_name, sandbox_name, **kwargs)

Get a sandbox # noqa: E501

Fetch the details about a given sandbox. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_sandbox_with_http_info(org_name, sandbox_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :param str sandbox_name: Sandbox Name (required) :return: Sandbox

If the method is called asynchronously, returns the request thread.

list_sandboxes(org_name, **kwargs)

List sandboxes # noqa: E501

List all sandboxes under the specified Signadot org. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_sandboxes(org_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :return: list[Sandbox]

If the method is called asynchronously, returns the request thread.

list_sandboxes_with_http_info(org_name, **kwargs)

List sandboxes # noqa: E501

List all sandboxes under the specified Signadot org. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_sandboxes_with_http_info(org_name, async_req=True) >>> result = thread.get()

:param async_req bool :param str org_name: Signadot Org Name (required) :return: list[Sandbox]

If the method is called asynchronously, returns the request thread.

Module contents