API Spec

clusters

GET /clusters/

API endpoint that allows cluster configs to be edited or deleted

Status Codes
Response JSON Object

  • [].api_endpoint (string) – Cluster Endpoint URL (required)

  • [].telemetry_endpoint (string) – Telemetry Endpoint URL (required)

  • [].title (string) – (required)

POST /clusters/

API endpoint that allows cluster configs to be edited or deleted

Request JSON Object

  • api_endpoint (string) – Cluster Endpoint URL (required)

  • telemetry_endpoint (string) – Telemetry Endpoint URL (required)

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_endpoint (string) – Cluster Endpoint URL (required)

  • telemetry_endpoint (string) – Telemetry Endpoint URL (required)

  • title (string) – (required)

GET /clusters/{id}/

API endpoint that allows cluster configs to be edited or deleted

Parameters

  • id (integer) – A unique integer value identifying this target cluster.

Status Codes
Response JSON Object

  • api_endpoint (string) – Cluster Endpoint URL (required)

  • telemetry_endpoint (string) – Telemetry Endpoint URL (required)

  • title (string) – (required)

PUT /clusters/{id}/

API endpoint that allows cluster configs to be edited or deleted

Parameters

  • id (integer) – A unique integer value identifying this target cluster.

Request JSON Object

  • api_endpoint (string) – Cluster Endpoint URL (required)

  • telemetry_endpoint (string) – Telemetry Endpoint URL (required)

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_endpoint (string) – Cluster Endpoint URL (required)

  • telemetry_endpoint (string) – Telemetry Endpoint URL (required)

  • title (string) – (required)

PATCH /clusters/{id}/

API endpoint that allows cluster configs to be edited or deleted

Parameters

  • id (integer) – A unique integer value identifying this target cluster.

Request JSON Object

  • api_endpoint (string) – Cluster Endpoint URL (required)

  • telemetry_endpoint (string) – Telemetry Endpoint URL (required)

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_endpoint (string) – Cluster Endpoint URL (required)

  • telemetry_endpoint (string) – Telemetry Endpoint URL (required)

  • title (string) – (required)

DELETE /clusters/{id}/

API endpoint that allows cluster configs to be edited or deleted

Parameters

  • id (integer) – A unique integer value identifying this target cluster.

Status Codes

configmaps

GET /configmaps/

API endpoint that allows configmaps to be edited or deleted

Status Codes
Response JSON Object

  • [].cluster (string) – ForeignKey to TargetCluster object.

  • [].description (string) –

  • [].kind (string) –

  • [].title (string) – (required)

POST /configmaps/

API endpoint that allows configmaps to be edited or deleted

Request JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) –

  • title (string) – (required)

GET /configmaps/{id}/

API endpoint that allows configmaps to be edited or deleted

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) –

  • title (string) – (required)

PUT /configmaps/{id}/

API endpoint that allows configmaps to be edited or deleted

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) –

  • title (string) – (required)

PATCH /configmaps/{id}/

API endpoint that allows configmaps to be edited or deleted

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) –

  • title (string) – (required)

DELETE /configmaps/{id}/

API endpoint that allows configmaps to be edited or deleted

Parameters

  • id (string) – UUID Auto field.

Status Codes
GET /configmaps/{id}/deploy/

Action to deploy the ConfigMap resource to target cluster.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) –

  • title (string) – (required)

GET /configmaps/{id}/remove/

Action to delete the kubernetes ConfigMap from the cluster.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) –

  • title (string) – (required)

containers

GET /containers/

API endpoint that allows containers to be edited or deleted.

Status Codes
Response JSON Object

  • [].args (string) – Comma separated args to run with command when instantiating container.

  • [].cluster (string) – ForeignKey to TargetCluster object.

  • [].command (string) – Command to run when start container

  • [].description (string) –

  • [].image_name (string) – Properly qualified image name.

  • [].image_pull_policy (string) –

  • [].image_tag (string) – Tag name for the image to be used for this job

  • [].port (integer) –

  • [].title (string) – (required)

  • [].volume_mount (string) –

POST /containers/

API endpoint that allows containers to be edited or deleted.

Request JSON Object

  • args (string) – Comma separated args to run with command when instantiating container.

  • cluster (string) – ForeignKey to TargetCluster object.

  • command (string) – Command to run when start container

  • description (string) –

  • image_name (string) – Properly qualified image name.

  • image_pull_policy (string) –

  • image_tag (string) – Tag name for the image to be used for this job

  • port (integer) –

  • title (string) – (required)

  • volume_mount (string) –

Status Codes
Response JSON Object

  • args (string) – Comma separated args to run with command when instantiating container.

  • cluster (string) – ForeignKey to TargetCluster object.

  • command (string) – Command to run when start container

  • description (string) –

  • image_name (string) – Properly qualified image name.

  • image_pull_policy (string) –

  • image_tag (string) – Tag name for the image to be used for this job

  • port (integer) –

  • title (string) – (required)

  • volume_mount (string) –

GET /containers/{id}/

API endpoint that allows containers to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • args (string) – Comma separated args to run with command when instantiating container.

  • cluster (string) – ForeignKey to TargetCluster object.

  • command (string) – Command to run when start container

  • description (string) –

  • image_name (string) – Properly qualified image name.

  • image_pull_policy (string) –

  • image_tag (string) – Tag name for the image to be used for this job

  • port (integer) –

  • title (string) – (required)

  • volume_mount (string) –

PUT /containers/{id}/

API endpoint that allows containers to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • args (string) – Comma separated args to run with command when instantiating container.

  • cluster (string) – ForeignKey to TargetCluster object.

  • command (string) – Command to run when start container

  • description (string) –

  • image_name (string) – Properly qualified image name.

  • image_pull_policy (string) –

  • image_tag (string) – Tag name for the image to be used for this job

  • port (integer) –

  • title (string) – (required)

  • volume_mount (string) –

Status Codes
Response JSON Object

  • args (string) – Comma separated args to run with command when instantiating container.

  • cluster (string) – ForeignKey to TargetCluster object.

  • command (string) – Command to run when start container

  • description (string) –

  • image_name (string) – Properly qualified image name.

  • image_pull_policy (string) –

  • image_tag (string) – Tag name for the image to be used for this job

  • port (integer) –

  • title (string) – (required)

  • volume_mount (string) –

PATCH /containers/{id}/

API endpoint that allows containers to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • args (string) – Comma separated args to run with command when instantiating container.

  • cluster (string) – ForeignKey to TargetCluster object.

  • command (string) – Command to run when start container

  • description (string) –

  • image_name (string) – Properly qualified image name.

  • image_pull_policy (string) –

  • image_tag (string) – Tag name for the image to be used for this job

  • port (integer) –

  • title (string) – (required)

  • volume_mount (string) –

Status Codes
Response JSON Object

  • args (string) – Comma separated args to run with command when instantiating container.

  • cluster (string) – ForeignKey to TargetCluster object.

  • command (string) – Command to run when start container

  • description (string) –

  • image_name (string) – Properly qualified image name.

  • image_pull_policy (string) –

  • image_tag (string) – Tag name for the image to be used for this job

  • port (integer) –

  • title (string) – (required)

  • volume_mount (string) –

DELETE /containers/{id}/

API endpoint that allows containers to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes

deployments

GET /deployments/

API endpoint that allows deployments to be edited or deleted.

Status Codes
Response JSON Object

  • [].api_version (string) – API version used to deploy child object.

  • [].cluster (string) – ForeignKey to TargetCluster object.

  • [].description (string) –

  • [].kind (string) – String representation of Kubernetes object kind (required)

  • [].kuid (string) – Object’s UID in the cluster

  • [].namespace (string) – Live namespace the object is associated with. (required)

  • [].pod_template (string) – (required)

  • [].port (integer) – Port object will expose

  • [].replicas (integer) –

  • [].title (string) – (required)

POST /deployments/

API endpoint that allows deployments to be edited or deleted.

Request JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • replicas (integer) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • replicas (integer) –

  • title (string) – (required)

GET /deployments/{id}/

API endpoint that allows deployments to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • replicas (integer) –

  • title (string) – (required)

PUT /deployments/{id}/

API endpoint that allows deployments to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • replicas (integer) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • replicas (integer) –

  • title (string) – (required)

PATCH /deployments/{id}/

API endpoint that allows deployments to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • replicas (integer) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • replicas (integer) –

  • title (string) – (required)

DELETE /deployments/{id}/

API endpoint that allows deployments to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes
GET /deployments/{id}/deploy/

Action to deploy the kubernetes resource to target cluster.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • replicas (integer) –

  • title (string) – (required)

GET /deployments/{id}/pod_usage/

Action to fetch point-in-time cpu and memory usage of pod.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • replicas (integer) –

  • title (string) – (required)

GET /deployments/{id}/remove/

Action to delete the kubernetes resource from the cluster/namespaces

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • replicas (integer) –

  • title (string) – (required)

ingresses

GET /ingresses/

API endpoint that allows ingress to be edited or deleted.

Status Codes
Response JSON Object

  • [].api_version (string) – API version used to deploy child object.

  • [].cluster (string) – ForeignKey to TargetCluster object.

  • [].description (string) –

  • [].hostname (string) –

  • [].kind (string) – String representation of Kubernetes object kind (required)

  • [].kuid (string) – Object’s UID in the cluster

  • [].namespace (string) – Live namespace the object is associated with. (required)

  • [].path (string) –

  • [].port (integer) – Port object will expose

  • [].target_service (string) – (required)

  • [].title (string) – (required)

POST /ingresses/

API endpoint that allows ingress to be edited or deleted.

Request JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • hostname (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • path (string) –

  • port (integer) – Port object will expose

  • target_service (string) – (required)

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • hostname (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • path (string) –

  • port (integer) – Port object will expose

  • target_service (string) – (required)

  • title (string) – (required)

GET /ingresses/{id}/

API endpoint that allows ingress to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • hostname (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • path (string) –

  • port (integer) – Port object will expose

  • target_service (string) – (required)

  • title (string) – (required)

PUT /ingresses/{id}/

API endpoint that allows ingress to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • hostname (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • path (string) –

  • port (integer) – Port object will expose

  • target_service (string) – (required)

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • hostname (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • path (string) –

  • port (integer) – Port object will expose

  • target_service (string) – (required)

  • title (string) – (required)

PATCH /ingresses/{id}/

API endpoint that allows ingress to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • hostname (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • path (string) –

  • port (integer) – Port object will expose

  • target_service (string) – (required)

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • hostname (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • path (string) –

  • port (integer) – Port object will expose

  • target_service (string) – (required)

  • title (string) – (required)

DELETE /ingresses/{id}/

API endpoint that allows ingress to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes
GET /ingresses/{id}/deploy/

Action to deploy the kubernetes resource to target cluster.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • hostname (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • path (string) –

  • port (integer) – Port object will expose

  • target_service (string) – (required)

  • title (string) – (required)

GET /ingresses/{id}/remove/

Action to delete the kubernetes resource from the cluster/namespace.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • hostname (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • path (string) –

  • port (integer) – Port object will expose

  • target_service (string) – (required)

  • title (string) – (required)

jobs

GET /jobs/

API endpoint that allows jobs to be edited or deleted.

Status Codes
Response JSON Object

  • [].api_version (string) – API version used to deploy child object.

  • [].backoff_limit (integer) –

  • [].cluster (string) – ForeignKey to TargetCluster object.

  • [].description (string) –

  • [].kind (string) – String representation of Kubernetes object kind (required)

  • [].kuid (string) – Object’s UID in the cluster

  • [].namespace (string) – Live namespace the object is associated with. (required)

  • [].pod_template (string) – (required)

  • [].port (integer) – Port object will expose

  • [].title (string) – (required)

POST /jobs/

API endpoint that allows jobs to be edited or deleted.

Request JSON Object

  • api_version (string) – API version used to deploy child object.

  • backoff_limit (integer) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • backoff_limit (integer) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • title (string) – (required)

GET /jobs/{id}/

API endpoint that allows jobs to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • backoff_limit (integer) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • title (string) – (required)

PUT /jobs/{id}/

API endpoint that allows jobs to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • api_version (string) – API version used to deploy child object.

  • backoff_limit (integer) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • backoff_limit (integer) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • title (string) – (required)

PATCH /jobs/{id}/

API endpoint that allows jobs to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • api_version (string) – API version used to deploy child object.

  • backoff_limit (integer) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • backoff_limit (integer) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • title (string) – (required)

DELETE /jobs/{id}/

API endpoint that allows jobs to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes
GET /jobs/{id}/deploy/

Action to deploy the kubernetes resource to target cluster.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • backoff_limit (integer) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • title (string) – (required)

GET /jobs/{id}/pod_usage/

Action to fetch point-in-time cpu and memory usage of pod.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • backoff_limit (integer) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • title (string) – (required)

GET /jobs/{id}/remove/

Action to delete the kubernetes resource from the target cluster/ns.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • backoff_limit (integer) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • pod_template (string) – (required)

  • port (integer) – Port object will expose

  • title (string) – (required)

mounts

GET /mounts/

API endpoint that allows volumes to be edited or deleted.

Status Codes
Response JSON Object

  • [].cluster (string) – ForeignKey to TargetCluster object.

  • [].description (string) –

  • [].mount_path (string) –

  • [].sub_path (string) –

  • [].title (string) – (required)

POST /mounts/

API endpoint that allows volumes to be edited or deleted.

Request JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • mount_path (string) –

  • sub_path (string) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • mount_path (string) –

  • sub_path (string) –

  • title (string) – (required)

GET /mounts/{id}/

API endpoint that allows volumes to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • mount_path (string) –

  • sub_path (string) –

  • title (string) – (required)

PUT /mounts/{id}/

API endpoint that allows volumes to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • mount_path (string) –

  • sub_path (string) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • mount_path (string) –

  • sub_path (string) –

  • title (string) – (required)

PATCH /mounts/{id}/

API endpoint that allows volumes to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • mount_path (string) –

  • sub_path (string) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • mount_path (string) –

  • sub_path (string) –

  • title (string) – (required)

DELETE /mounts/{id}/

API endpoint that allows volumes to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes

namespaces

GET /namespaces/

API endpoint that allows namespaces to be created or deleted

Status Codes
Response JSON Object

  • [].api_version (string) –

  • [].cluster (string) – ForeignKey to TargetCluster object.

  • [].description (string) –

  • [].exists (boolean) –

  • [].kind (string) –

  • [].title (string) – (required)

POST /namespaces/

API endpoint that allows namespaces to be created or deleted

Request JSON Object

  • api_version (string) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • exists (boolean) –

  • kind (string) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • exists (boolean) –

  • kind (string) –

  • title (string) – (required)

GET /namespaces/{id}/

API endpoint that allows namespaces to be created or deleted

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • exists (boolean) –

  • kind (string) –

  • title (string) – (required)

PUT /namespaces/{id}/

API endpoint that allows namespaces to be created or deleted

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • api_version (string) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • exists (boolean) –

  • kind (string) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • exists (boolean) –

  • kind (string) –

  • title (string) – (required)

PATCH /namespaces/{id}/

API endpoint that allows namespaces to be created or deleted

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • api_version (string) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • exists (boolean) –

  • kind (string) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • exists (boolean) –

  • kind (string) –

  • title (string) – (required)

DELETE /namespaces/{id}/

API endpoint that allows namespaces to be created or deleted

Parameters

  • id (string) – UUID Auto field.

Status Codes
GET /namespaces/{id}/deploy/

Action to deploy the namespace resource to target cluster.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • exists (boolean) –

  • kind (string) –

  • title (string) – (required)

GET /namespaces/{id}/remove/

Action to delete the kubernetes namespace from the cluster.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) –

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • exists (boolean) –

  • kind (string) –

  • title (string) – (required)

pods

GET /pods/

API endpoint that allows pod templates to be edited or deleted.

Status Codes
Response JSON Object

  • [].cluster (string) – ForeignKey to TargetCluster object.

  • [].description (string) –

  • [].primary_container (string) – (required)

  • [].restart_policy (string) –

  • [].secondary_container (string) –

  • [].title (string) – (required)

  • [].volume (string) –

POST /pods/

API endpoint that allows pod templates to be edited or deleted.

Request JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • primary_container (string) – (required)

  • restart_policy (string) –

  • secondary_container (string) –

  • title (string) – (required)

  • volume (string) –

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • primary_container (string) – (required)

  • restart_policy (string) –

  • secondary_container (string) –

  • title (string) – (required)

  • volume (string) –

GET /pods/{id}/

API endpoint that allows pod templates to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • primary_container (string) – (required)

  • restart_policy (string) –

  • secondary_container (string) –

  • title (string) – (required)

  • volume (string) –

PUT /pods/{id}/

API endpoint that allows pod templates to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • primary_container (string) – (required)

  • restart_policy (string) –

  • secondary_container (string) –

  • title (string) – (required)

  • volume (string) –

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • primary_container (string) – (required)

  • restart_policy (string) –

  • secondary_container (string) –

  • title (string) – (required)

  • volume (string) –

PATCH /pods/{id}/

API endpoint that allows pod templates to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • primary_container (string) – (required)

  • restart_policy (string) –

  • secondary_container (string) –

  • title (string) – (required)

  • volume (string) –

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • primary_container (string) – (required)

  • restart_policy (string) –

  • secondary_container (string) –

  • title (string) – (required)

  • volume (string) –

DELETE /pods/{id}/

API endpoint that allows pod templates to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes

services

GET /services/

API endpoint that allows services to be edited or deleted.

Status Codes
Response JSON Object

  • [].api_version (string) – API version used to deploy child object.

  • [].cluster (string) – ForeignKey to TargetCluster object.

  • [].description (string) –

  • [].kind (string) – String representation of Kubernetes object kind (required)

  • [].kuid (string) – Object’s UID in the cluster

  • [].namespace (string) – Live namespace the object is associated with. (required)

  • [].port (integer) – Port object will expose

  • [].target_port (integer) –

  • [].title (string) – (required)

POST /services/

API endpoint that allows services to be edited or deleted.

Request JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • port (integer) – Port object will expose

  • target_port (integer) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • port (integer) – Port object will expose

  • target_port (integer) –

  • title (string) – (required)

GET /services/{id}/

API endpoint that allows services to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • port (integer) – Port object will expose

  • target_port (integer) –

  • title (string) – (required)

PUT /services/{id}/

API endpoint that allows services to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • port (integer) – Port object will expose

  • target_port (integer) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • port (integer) – Port object will expose

  • target_port (integer) –

  • title (string) – (required)

PATCH /services/{id}/

API endpoint that allows services to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • port (integer) – Port object will expose

  • target_port (integer) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • port (integer) – Port object will expose

  • target_port (integer) –

  • title (string) – (required)

DELETE /services/{id}/

API endpoint that allows services to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes
GET /services/{id}/deploy/

Action to deploy the kubernetes resource to target cluster.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • port (integer) – Port object will expose

  • target_port (integer) –

  • title (string) – (required)

GET /services/{id}/remove/

Action to delete the kubernetes resource from the cluster/namespace.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • api_version (string) – API version used to deploy child object.

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • kind (string) – String representation of Kubernetes object kind (required)

  • kuid (string) – Object’s UID in the cluster

  • namespace (string) – Live namespace the object is associated with. (required)

  • port (integer) – Port object will expose

  • target_port (integer) –

  • title (string) – (required)

volumes

GET /volumes/

API endpoint that allows volumes to be edited or deleted.

Status Codes
Response JSON Object

  • [].cluster (string) – ForeignKey to TargetCluster object.

  • [].description (string) –

  • [].title (string) – (required)

POST /volumes/

API endpoint that allows volumes to be edited or deleted.

Request JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • title (string) – (required)

GET /volumes/{id}/

API endpoint that allows volumes to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • title (string) – (required)

PUT /volumes/{id}/

API endpoint that allows volumes to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • title (string) – (required)

PATCH /volumes/{id}/

API endpoint that allows volumes to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Request JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • title (string) – (required)

Status Codes
Response JSON Object

  • cluster (string) – ForeignKey to TargetCluster object.

  • description (string) –

  • title (string) – (required)

DELETE /volumes/{id}/

API endpoint that allows volumes to be edited or deleted.

Parameters

  • id (string) – UUID Auto field.

Status Codes