Skip to main content
API docs by Redocly

platz-api (0.7.0-beta.5)

Download OpenAPI specification:Download

License: Apache-2.0

Authentication

APIs for logging into Platz and getting information about the current user.

startGoogleLogin

Responses

Response samples

Content type
application/json
{
  • "redirect_url": "string"
}

finishGoogleLogin

Request Body schema: application/json
required
auth_code
required
string

Responses

Request samples

Content type
application/json
{
  • "auth_code": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string"
}

authMe

Authorizations:
access_tokenuser_token

Responses

Response samples

Content type
application/json
{
  • "Deployment": {
    }
}

Deployment Kinds

Deployment kinds map between kind IDs and their names.

allDeploymentKinds

Authorizations:
access_tokenuser_token
query Parameters
name
string or null

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

getDeploymentKind

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string"
}

updateDeploymentKind

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string"
}

Deployment Permissions

APIs for setting deployment permissions per user.

See UserDeploymentRole for more information.

allDeploymentPermissions

Authorizations:
access_tokenuser_token
query Parameters
env_id
string or null <uuid>

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

createDeploymentPermission

Authorizations:
access_tokenuser_token
Request Body schema: application/json
required
env_id
required
string <uuid>
user_id
required
string <uuid>
kind_id
required
string <uuid>
role
required
string (UserDeploymentRole)
Enum: "Owner" "Maintainer"

Responses

Request samples

Content type
application/json
{
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "kind_id": "81882b69-6950-4084-9a10-b06e0e425be7",
  • "role": "Owner"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "kind_id": "81882b69-6950-4084-9a10-b06e0e425be7",
  • "role": "Owner"
}

getDeploymentPermission

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "kind_id": "81882b69-6950-4084-9a10-b06e0e425be7",
  • "role": "Owner"
}

deleteDeploymentPermission

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Deployment Resource Types

Deployment resource types are custom types defined in a chart's extensions contained in the platz directory in the deployment Helm chart.

allDeploymentResourceTypes

Authorizations:
access_tokenuser_token
query Parameters
env_id
string or null <uuid>
deployment_kind_id
string or null <uuid>
key
string or null

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

getDeploymentResourceType

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "deployment_kind_id": "c0550b36-8ac0-4128-9349-8062c17e6717",
  • "key": "string",
  • "spec": {
    }
}

Deployment Resources

allDeploymentResources

Authorizations:
access_tokenuser_token
query Parameters
type_id
string or null <uuid>

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

createDeploymentResource

Authorizations:
access_tokenuser_token
Request Body schema: application/json
required
id
string or null <uuid>
created_at
string or null <date-time>
type_id
required
string <uuid>
deployment_id
required
string <uuid>
name
required
string
props
required
any
null or DeploymentResourceSyncStatus (string)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "type_id": "d9779ea4-ba95-4824-86d7-4f1ac083a564",
  • "deployment_id": "6ef0ac85-9892-4664-a2a5-58bf2af5a8a6",
  • "name": "string",
  • "props": null,
  • "sync_status": { }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "type_id": "d9779ea4-ba95-4824-86d7-4f1ac083a564",
  • "deployment_id": "6ef0ac85-9892-4664-a2a5-58bf2af5a8a6",
  • "name": "string",
  • "exists": true,
  • "props": null,
  • "sync_status": "Creating",
  • "sync_reason": "string"
}

getDeploymentResource

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "type_id": "d9779ea4-ba95-4824-86d7-4f1ac083a564",
  • "deployment_id": "6ef0ac85-9892-4664-a2a5-58bf2af5a8a6",
  • "name": "string",
  • "exists": true,
  • "props": null,
  • "sync_status": "Creating",
  • "sync_reason": "string"
}

updateDeploymentResource

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
name
string or null
props
any

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "props": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "type_id": "d9779ea4-ba95-4824-86d7-4f1ac083a564",
  • "deployment_id": "6ef0ac85-9892-4664-a2a5-58bf2af5a8a6",
  • "name": "string",
  • "exists": true,
  • "props": null,
  • "sync_status": "Creating",
  • "sync_reason": "string"
}

deleteDeploymentResource

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Deployment Tasks

Deployment tasks are all operations performed on each deployment, along with their status.

allDeploymentTasks

Authorizations:
access_tokenuser_token
query Parameters
cluster_id
string or null <uuid>
deployment_id
string or null <uuid>

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

createDeploymentTask

Authorizations:
access_tokenuser_token
Request Body schema: application/json
required
deployment_id
required
string <uuid>
required
object or object or object or object or object or object or object (DeploymentTaskOperation)
execute_at
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "deployment_id": "6ef0ac85-9892-4664-a2a5-58bf2af5a8a6",
  • "operation": {
    },
  • "execute_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "execute_at": "2019-08-24T14:15:22Z",
  • "first_attempted_at": "2019-08-24T14:15:22Z",
  • "started_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "deployment_id": "6ef0ac85-9892-4664-a2a5-58bf2af5a8a6",
  • "acting_user_id": "06bbfdfe-c8d2-4dd9-9285-42114ae06d00",
  • "acting_deployment_id": "dfd6332b-7027-4d59-9e83-ffd4b6ff057a",
  • "canceled_by_user_id": "d0428438-976c-42d5-b48b-e0f42ff4ac26",
  • "canceled_by_deployment_id": "c00d08da-8985-441c-a78d-4074a75582db",
  • "operation": {
    },
  • "status": "Pending",
  • "reason": "string"
}

getDeploymentTask

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "execute_at": "2019-08-24T14:15:22Z",
  • "first_attempted_at": "2019-08-24T14:15:22Z",
  • "started_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "deployment_id": "6ef0ac85-9892-4664-a2a5-58bf2af5a8a6",
  • "acting_user_id": "06bbfdfe-c8d2-4dd9-9285-42114ae06d00",
  • "acting_deployment_id": "dfd6332b-7027-4d59-9e83-ffd4b6ff057a",
  • "canceled_by_user_id": "d0428438-976c-42d5-b48b-e0f42ff4ac26",
  • "canceled_by_deployment_id": "c00d08da-8985-441c-a78d-4074a75582db",
  • "operation": {
    },
  • "status": "Pending",
  • "reason": "string"
}

Deployments

This collection contains deployments of Helm chart into envs.

allDeployments

Authorizations:
access_tokenuser_token
query Parameters
name
string or null
kind_id
string or null <uuid>
cluster_id
string or null <uuid>
enabled
boolean or null

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

createDeployment

Authorizations:
access_tokenuser_token
Request Body schema: application/json
required
name
string
kind_id
required
string <uuid>
cluster_id
required
string <uuid>
helm_chart_id
required
string <uuid>
config
required
any
values_override
required
any

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "kind_id": "81882b69-6950-4084-9a10-b06e0e425be7",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "helm_chart_id": "ba4bffbc-f5d0-498b-9478-a9b14e793133",
  • "config": null,
  • "values_override": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "kind_id": "81882b69-6950-4084-9a10-b06e0e425be7",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "enabled": true,
  • "status": "Unknown",
  • "description_md": "string",
  • "reason": "string",
  • "revision_id": "f8f7f022-982b-4bef-ba7d-4bb808fdbe2a",
  • "reported_status": { },
  • "helm_chart_id": "ba4bffbc-f5d0-498b-9478-a9b14e793133",
  • "config": null,
  • "values_override": null
}

getDeployment

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "kind_id": "81882b69-6950-4084-9a10-b06e0e425be7",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "enabled": true,
  • "status": "Unknown",
  • "description_md": "string",
  • "reason": "string",
  • "revision_id": "f8f7f022-982b-4bef-ba7d-4bb808fdbe2a",
  • "reported_status": { },
  • "helm_chart_id": "ba4bffbc-f5d0-498b-9478-a9b14e793133",
  • "config": null,
  • "values_override": null
}

updateDeployment

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
name
string or null
cluster_id
string or null <uuid>
helm_chart_id
string or null <uuid>
config
any
values_override
any
enabled
boolean or null
description_md
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "helm_chart_id": "ba4bffbc-f5d0-498b-9478-a9b14e793133",
  • "config": null,
  • "values_override": null,
  • "enabled": true,
  • "description_md": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "kind_id": "81882b69-6950-4084-9a10-b06e0e425be7",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "enabled": true,
  • "status": "Unknown",
  • "description_md": "string",
  • "reason": "string",
  • "revision_id": "f8f7f022-982b-4bef-ba7d-4bb808fdbe2a",
  • "reported_status": { },
  • "helm_chart_id": "ba4bffbc-f5d0-498b-9478-a9b14e793133",
  • "config": null,
  • "values_override": null
}

deleteDeployment

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Env User Permissions

Controls which envs each user can see.

allEnvUserPermissions

Authorizations:
access_tokenuser_token
query Parameters
env_id
string or null <uuid>

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

createEnvUserPermission

Authorizations:
access_tokenuser_token
Request Body schema: application/json
required
env_id
required
string <uuid>
user_id
required
string <uuid>
role
required
string (EnvUserRole)
Enum: "Admin" "User"

Responses

Request samples

Content type
application/json
{
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "role": "Admin"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "role": "Admin"
}

getEnvUserPermission

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "role": "Admin"
}

deleteEnvUserPermission

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Envs

Envs contain deployments and all related settings resources for those deployments, such as deployment permissions.

allEnvs

Authorizations:
access_tokenuser_token
query Parameters
name
string or null
auto_add_new_users
boolean or null

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

createEnv

Authorizations:
access_tokenuser_token
Request Body schema: application/json
required
name
required
string
auto_add_new_users
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "auto_add_new_users": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "node_selector": null,
  • "tolerations": null,
  • "auto_add_new_users": true
}

getEnv

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "node_selector": null,
  • "tolerations": null,
  • "auto_add_new_users": true
}

updateEnv

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
name
string or null
node_selector
any
tolerations
any
auto_add_new_users
boolean or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "node_selector": null,
  • "tolerations": null,
  • "auto_add_new_users": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "node_selector": null,
  • "tolerations": null,
  • "auto_add_new_users": true
}

deleteEnv

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Helm Charts

This collection contains Helm charts detected by the chart-discovery service.

allHelmCharts

Authorizations:
access_tokenuser_token
query Parameters
helm_registry_id
string or null <uuid>
parsed_branch
string or null

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

getHelmChart

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "helm_registry_id": "9f0e25ce-62e2-4f39-9a2a-36b15b71aa82",
  • "image_digest": "string",
  • "image_tag": "string",
  • "available": true,
  • "values_ui": { },
  • "actions_schema": { },
  • "features": { },
  • "resource_types": { },
  • "error": "string",
  • "tag_format_id": "498dd47d-8863-4bba-a704-715fe5abe012",
  • "parsed_version": "string",
  • "parsed_revision": "string",
  • "parsed_branch": "string",
  • "parsed_commit": "string"
}

Helm Registries

This collection contains Helm registries detected by the chart-discovery service.

New registries are created automatically for Helm chart whenever new charts are created in those registries.

allHelmRegistries

Authorizations:
access_tokenuser_token
query Parameters
repo_name
string or null
kind_id
string or null <uuid>

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

getHelmRegistry

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "domain_name": "string",
  • "repo_name": "string",
  • "kind_id": "81882b69-6950-4084-9a10-b06e0e425be7",
  • "available": true,
  • "fa_icon": "string",
  • "provider": "Ecr"
}

updateHelmRegistry

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
fa_icon
string or null

Responses

Request samples

Content type
application/json
{
  • "fa_icon": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "domain_name": "string",
  • "repo_name": "string",
  • "kind_id": "81882b69-6950-4084-9a10-b06e0e425be7",
  • "available": true,
  • "fa_icon": "string",
  • "provider": "Ecr"
}

Helm Tag Formats

Helm tag formats are how Platz parsed tags of Helm charts in registries.

Each format is a regular expression containing groups for the chart version, Git commit and branch.

allHelmTagFormats

Authorizations:
access_tokenuser_token
query Parameters
pattern
string or null

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

createHelmTagFormat

Authorizations:
access_tokenuser_token
Request Body schema: application/json
required
pattern
required
string

Responses

Request samples

Content type
application/json
{
  • "pattern": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "pattern": "string"
}

getHelmTagFormat

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "pattern": "string"
}

deleteHelmTagFormat

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Kubernetes Clusters

This collection contains Kubernetes clusters detected by Plaz.

allK8sClusters

Authorizations:
access_tokenuser_token
query Parameters
env_id
string or null <uuid>
name
string or null

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

getK8sCluster

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "provider_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_seen_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "region_name": "string",
  • "is_ok": true,
  • "not_ok_reason": "string",
  • "ignore": true,
  • "ingress_domain": "string",
  • "ingress_class": "string",
  • "ingress_tls_secret_name": "string",
  • "grafana_url": "string",
  • "grafana_datasource_name": "string"
}

updateK8sCluster

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
env_id
string or null <uuid>
ignore
boolean or null
ingress_domain
string or null
ingress_class
string or null
ingress_tls_secret_name
string or null
grafana_url
string or null
grafana_datasource_name
string or null

Responses

Request samples

Content type
application/json
{
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "ignore": true,
  • "ingress_domain": "string",
  • "ingress_class": "string",
  • "ingress_tls_secret_name": "string",
  • "grafana_url": "string",
  • "grafana_datasource_name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "provider_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_seen_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "region_name": "string",
  • "is_ok": true,
  • "not_ok_reason": "string",
  • "ignore": true,
  • "ingress_domain": "string",
  • "ingress_class": "string",
  • "ingress_tls_secret_name": "string",
  • "grafana_url": "string",
  • "grafana_datasource_name": "string"
}

deleteK8sCluster

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Kubernetes Resources

This collection contains Kubernetes resources of Platz deployments.

Kubernetes resources are automatically tracked in every namespace created by Platz.

allK8sResources

Authorizations:
access_tokenuser_token
query Parameters
cluster_id
string or null <uuid>
deployment_id
string or null <uuid>
kind
string or null
name
string or null

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

getK8sResource

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "last_updated_at": "2019-08-24T14:15:22Z",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "deployment_id": "6ef0ac85-9892-4664-a2a5-58bf2af5a8a6",
  • "kind": "string",
  • "api_version": "string",
  • "name": "string",
  • "status_color": [
    ],
  • "metadata": null
}

Secrets

Secrets are stored in envs and can be referenced by chart inputs by using the secrets collection.

Kubernetes secrets are created during deployment as defined in the chart extensions. See chart extensions documentation for more information.

allSecrets

Authorizations:
access_tokenuser_token
query Parameters
env_id
string or null <uuid>
collection
string or null
name
string or null

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

createSecret

Authorizations:
access_tokenuser_token
Request Body schema: application/json
required
env_id
required
string <uuid>
collection
required
string
name
required
string
contents
required
string

Responses

Request samples

Content type
application/json
{
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "collection": "string",
  • "name": "string",
  • "contents": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "collection": "string",
  • "name": "string"
}

getSecret

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "collection": "string",
  • "name": "string"
}

updateSecret

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
name
string or null
contents
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "contents": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "env_id": "3f917d0d-4dff-42f3-97c4-6a5455dfe8c2",
  • "collection": "string",
  • "name": "string"
}

deleteSecret

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Server

Return information about the Platz server.

getServerInfo

Authorizations:
access_tokenuser_token

Responses

Response samples

Content type
application/json
{
  • "version": "string"
}

User Tokens

User tokens allow users to authenticate using a long-lived token that can be used in direct API calls, CLI, etc.

User tokens are passed in the x-platz-token header.

allUserTokens

Authorizations:
access_tokenuser_token
query Parameters
user_id
string or null <uuid>

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

createUserToken

Authorizations:
access_tokenuser_token
Request Body schema: application/json
required
user_id
required
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Response samples

Content type
application/json
{
  • "created_token": "string"
}

getUserToken

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "created_at": "2019-08-24T14:15:22Z"
}

deleteUserToken

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Users

This collection contains all users in Platz.

allUsers

Authorizations:
access_tokenuser_token
query Parameters
display_name
string or null
email
string or null
is_active
boolean or null

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

getUser

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "display_name": "string",
  • "email": "string",
  • "is_admin": true,
  • "is_active": true
}

updateUser

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
is_admin
boolean or null
is_active
boolean or null

Responses

Request samples

Content type
application/json
{
  • "is_admin": true,
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "display_name": "string",
  • "email": "string",
  • "is_admin": true,
  • "is_active": true
}

Bots

This collection contains all bots in Platz.

allBots

Authorizations:
access_tokenuser_token
query Parameters
display_name
string or null

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

createBot

Authorizations:
access_tokenuser_token
Request Body schema: application/json
required
display_name
required
string

Responses

Request samples

Content type
application/json
{
  • "display_name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "display_name": "string"
}

getBot

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "display_name": "string"
}

updateBot

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
display_name
string or null

Responses

Request samples

Content type
application/json
{
  • "display_name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "display_name": "string"
}

deleteBot

Authorizations:
access_tokenuser_token
path Parameters
id
required
string <uuid>

Responses

Bot Tokens

Bot tokens allow bots to authenticate using a long-lived token that can be used in direct API calls, CLI, etc.

Bot tokens are passed in the x-platz-token header.

allBotTokens

Authorizations:
access_token
query Parameters
bot_id
string or null <uuid>
created_by_user_id
string or null <uuid>

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "items": [
    ],
  • "num_total": 0
}

createBotToken

Authorizations:
access_token
Request Body schema: application/json
required
bot_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "bot_id": "41900e0f-e27a-4863-8321-478ccf15bbd8"
}

Response samples

Content type
application/json
{
  • "created_token": "string"
}

getBotToken

Authorizations:
access_token
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "bot_id": "41900e0f-e27a-4863-8321-478ccf15bbd8",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by_user_id": "209f54c4-4c33-43bc-9c6a-ef4c65ad7473"
}

deleteBotToken

Authorizations:
access_token
path Parameters
id
required
string <uuid>

Responses

Events

Events sent through the Websocket.