API docs by Redocly

Wodby 2.0 Public API (1.0.0)

Download OpenAPI specification:

Public REST API for customer SDKs and code integrations. GraphQL remains internal for the dashboard. This contract is the versioned public surface.

orgs

List orgs

Authorizations:
apiKeyHeaderaccessTokenHeader

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create org

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
name
required
string
title
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "domain": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update org

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
title
required
string
registryIntegrationID
integer or null
ciIntegrationID
integer or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "registryIntegrationID": 0,
  • "ciIntegrationID": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "domain": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete org

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

projects

List projects

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
orgId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create project

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
orgID
required
integer
name
required
string
title
required
string
teamIDs
Array of integers
orgMembershipIDs
Array of integers
role
string

Responses

Request samples

Content type
application/json
{
  • "orgID": 0,
  • "name": "string",
  • "title": "string",
  • "teamIDs": [
    ],
  • "orgMembershipIDs": [
    ],
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get project by name

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
name
required
string
query Parameters
orgId
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update project

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
title
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete project

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

apps

List apps

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
orgId
required
integer
projectIds
string

Comma-separated project ids

clusterApp
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create app

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
orgID
required
integer
name
required
string
title
required
string
instanceName
required
string
instanceTitle
required
string
domain
required
string
projectID
integer or null
stackRevID
required
integer
required
Array of objects (NewAppServiceInput)
clusterID
integer or null
object (NewManagedClusterInput)
envID
required
integer
ciIntegrationID
integer or null
registryIntegrationID
integer or null

Responses

Request samples

Content type
application/json
{
  • "orgID": 0,
  • "name": "string",
  • "title": "string",
  • "instanceName": "string",
  • "instanceTitle": "string",
  • "domain": "string",
  • "projectID": 0,
  • "stackRevID": 0,
  • "services": [
    ],
  • "clusterID": 0,
  • "newCluster": {
    },
  • "envID": 0,
  • "ciIntegrationID": 0,
  • "registryIntegrationID": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "clusterApp": true,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get app by name

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
name
required
string
query Parameters
orgId
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "clusterApp": true,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get app

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "clusterApp": true,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update app

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
title
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "clusterApp": true,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete app

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

app-instances

List app instances

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
orgId
required
integer
projectIds
string

Comma-separated project ids

appId
integer
clusterId
integer
clusterApp
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create app instance

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
appID
required
integer
instanceName
required
string
instanceTitle
required
string
domain
required
string
stackRevID
required
integer
required
Array of objects (NewAppServiceInput)
clusterID
integer or null
object (NewManagedClusterInput)
envID
required
integer
ciIntegrationID
integer or null
registryIntegrationID
integer or null

Responses

Request samples

Content type
application/json
{
  • "appID": 0,
  • "instanceName": "string",
  • "instanceTitle": "string",
  • "domain": "string",
  • "stackRevID": 0,
  • "services": [
    ],
  • "clusterID": 0,
  • "newCluster": {
    },
  • "envID": 0,
  • "ciIntegrationID": 0,
  • "registryIntegrationID": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "mainDomain": "string",
  • "appId": 0,
  • "clusterId": 0,
  • "envId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get app instance by app and instance name

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
appName
required
string
instanceName
required
string
query Parameters
orgId
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "mainDomain": "string",
  • "appId": 0,
  • "clusterId": 0,
  • "envId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get app instance

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "mainDomain": "string",
  • "appId": 0,
  • "clusterId": 0,
  • "envId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update app instance

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
title
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "mainDomain": "string",
  • "appId": 0,
  • "clusterId": 0,
  • "envId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete app instance

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
query Parameters
force
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

app-services

List app services

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
appInstanceId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get app service

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "status": "string",
  • "replicas": 0,
  • "version": "string",
  • "main": true,
  • "disabled": true,
  • "external": true,
  • "required": true,
  • "needsRebuild": true,
  • "needsRedeploy": true,
  • "configurationReady": true,
  • "appInstanceId": 0,
  • "serviceRevId": 0,
  • "parentAppServiceId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update app service

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
replicas
integer or null
version
string or null
disabled
boolean or null
main
boolean or null
object (BuildSourceInput)

Responses

Request samples

Content type
application/json
{
  • "replicas": 0,
  • "version": "string",
  • "disabled": true,
  • "main": true,
  • "buildSource": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "status": "string",
  • "replicas": 0,
  • "version": "string",
  • "main": true,
  • "disabled": true,
  • "external": true,
  • "required": true,
  • "needsRebuild": true,
  • "needsRedeploy": true,
  • "configurationReady": true,
  • "appInstanceId": 0,
  • "serviceRevId": 0,
  • "parentAppServiceId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Run app service action

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
name
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

app-deployments

List app deployments

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
appInstanceId
required
integer
page
integer >= 1

Page number, defaults to 1

pageSize
integer >= 1

Page size, defaults to 30

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "nextPage": 0
}

Create deployment

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
required
Array of objects (AppServiceDeploymentRequest)
skipRollback
boolean or null

Responses

Request samples

Content type
application/json
{
  • "services": [
    ],
  • "skipRollback": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "skipRollback": true,
  • "appInstanceId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z"
}

Create deployment from CI

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
appBuildID
required
integer
required
Array of objects (ServiceDeploymentInput)
skipPostDeployment
required
boolean

Responses

Request samples

Content type
application/json
{
  • "appBuildID": 0,
  • "services": [
    ],
  • "skipPostDeployment": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "skipRollback": true,
  • "appInstanceId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z"
}

Get deployment

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "skipRollback": true,
  • "appInstanceId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z"
}

Redeploy deployment

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "skipRollback": true,
  • "appInstanceId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z"
}

app-builds

List app builds

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
appInstanceId
required
integer
page
integer >= 1

Page number, defaults to 1

pageSize
integer >= 1

Page size, defaults to 30

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "nextPage": 0
}

Create build

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
appServiceId
integer
appServiceIds
Array of integers

Responses

Request samples

Content type
application/json
{
  • "appServiceId": 0,
  • "appServiceIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Create build from CI

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
appServiceID
required
integer
gitCommitSHA
required
string
gitRef
required
string
gitRefType
required
string
buildNum
required
integer
buildID
required
string
workflow
string or null
gitCommitAuthorName
string or null
gitCommitAuthorEmail
string or null
gitCommitMessage
string or null
provider
required
string
postDeployment
string or null

Responses

Request samples

Content type
application/json
{
  • "appServiceID": 0,
  • "gitCommitSHA": "string",
  • "gitRef": "string",
  • "gitRefType": "string",
  • "buildNum": 0,
  • "buildID": "string",
  • "workflow": "string",
  • "gitCommitAuthorName": "string",
  • "gitCommitAuthorEmail": "string",
  • "gitCommitMessage": "string",
  • "provider": "string",
  • "postDeployment": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "gitRefType": "string",
  • "gitRef": "string",
  • "commitHash": "string",
  • "commitMessage": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z"
}

Get build

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "gitRefType": "string",
  • "gitRef": "string",
  • "commitHash": "string",
  • "commitMessage": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z"
}

Get Docker registry credentials for build

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Deploy build

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "skipRollback": true,
  • "appInstanceId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z"
}

Void build images

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "gitRefType": "string",
  • "gitRef": "string",
  • "commitHash": "string",
  • "commitMessage": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z"
}

clusters

List clusters

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
orgId
required
integer
projectIds
string

Comma-separated project ids

integrationId
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create cluster

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
orgID
required
integer
projectID
integer or null
integrationID
required
integer
name
required
string
title
required
string
serverless
required
boolean
singleNode
boolean or null
version
string or null
machineType
string or null
minNodeCount
integer or null
maxNodeCount
integer or null
nodeDiskSize
integer or null
zone
string or null
region
string or null
billingOption
string or null
disableMonitoring
required
boolean

Responses

Request samples

Content type
application/json
{
  • "orgID": 0,
  • "projectID": 0,
  • "integrationID": 0,
  • "name": "string",
  • "title": "string",
  • "serverless": true,
  • "singleNode": true,
  • "version": "string",
  • "machineType": "string",
  • "minNodeCount": 0,
  • "maxNodeCount": 0,
  • "nodeDiskSize": 0,
  • "zone": "string",
  • "region": "string",
  • "billingOption": "string",
  • "disableMonitoring": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "serverless": true,
  • "version": "string",
  • "region": "string",
  • "zone": "string",
  • "integrationId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get cluster

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "serverless": true,
  • "version": "string",
  • "region": "string",
  • "zone": "string",
  • "integrationId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update cluster

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
title
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "serverless": true,
  • "version": "string",
  • "region": "string",
  • "zone": "string",
  • "integrationId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete cluster

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
query Parameters
force
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

databases

List databases

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
orgId
required
integer
projectIds
string

Comma-separated project ids

kind
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create database

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
orgID
required
integer
projectID
integer or null
envID
required
integer
name
required
string
title
required
string
integrationKindID
required
integer
type
required
string
version
required
string
machineType
required
string
storageSize
integer or null
password
string or null
storageAutoscaling
boolean or null
highAvailability
boolean or null
region
string or null
zone
string or null
residedClusterID
integer or null
iops
integer or null

Responses

Request samples

Content type
application/json
{
  • "orgID": 0,
  • "projectID": 0,
  • "envID": 0,
  • "name": "string",
  • "title": "string",
  • "integrationKindID": 0,
  • "type": "string",
  • "version": "string",
  • "machineType": "string",
  • "storageSize": 0,
  • "password": "string",
  • "storageAutoscaling": true,
  • "highAvailability": true,
  • "region": "string",
  • "zone": "string",
  • "residedClusterID": 0,
  • "iops": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "kind": "string",
  • "status": "string",
  • "version": "string",
  • "region": "string",
  • "zone": "string",
  • "integrationId": 0,
  • "envId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get database

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "kind": "string",
  • "status": "string",
  • "version": "string",
  • "region": "string",
  • "zone": "string",
  • "integrationId": 0,
  • "envId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update database

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
title
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "kind": "string",
  • "status": "string",
  • "version": "string",
  • "region": "string",
  • "zone": "string",
  • "integrationId": 0,
  • "envId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete database

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

integrations

List integrations

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
orgId
required
integer
projectIds
string

Comma-separated project ids

labels
string

Comma-separated labels

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create integration

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
orgID
required
integer
providerID
required
integer
name
required
string
title
required
string
kinds
required
Array of strings
auth
string or null
projectID
integer or null
Array of objects (FieldInput)
scope
string or null

Responses

Request samples

Content type
application/json
{
  • "orgID": 0,
  • "providerID": 0,
  • "name": "string",
  • "title": "string",
  • "kinds": [
    ],
  • "auth": "string",
  • "projectID": 0,
  • "fieldsInput": [
    ],
  • "scope": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "scope": "string",
  • "auth": "string",
  • "providerRevId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get integration by name

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
name
required
string
query Parameters
orgId
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "scope": "string",
  • "auth": "string",
  • "providerRevId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

List integration scopes

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List remote Git repositories

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List remote Git repository branches

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
query Parameters
remoteGitRepoId
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

List remote Git repository tags

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
query Parameters
remoteGitRepoId
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

List Kubernetes regions

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • { }
]

List Kubernetes zones

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • { }
]

List Kubernetes machine types

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
query Parameters
location
required
string

Responses

Response samples

Content type
application/json
[
  • { }
]

List Kubernetes versions

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
query Parameters
location
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Kubernetes settings

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{ }

List storage buckets

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • "string"
]

List storage classes

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • "string"
]

Update integration

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
title
required
string
name
required
string
kinds
required
Array of strings
scope
string or null
Array of objects (FieldInput)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "name": "string",
  • "kinds": [
    ],
  • "scope": "string",
  • "fieldsInput": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "scope": "string",
  • "auth": "string",
  • "providerRevId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete integration

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

integration-kinds

List database types

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List database regions

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
query Parameters
dbType
required
string
version
required
string
ha
boolean
Default: false

Responses

Response samples

Content type
application/json
[
  • { }
]

List database versions

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
query Parameters
dbType
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List database machine types

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
query Parameters
dbType
required
string
version
required
string
ha
boolean
Default: false
region
string
zone
string

Responses

Response samples

Content type
application/json
[
  • { }
]

Get database settings

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
query Parameters
dbType
required
string

Responses

Response samples

Content type
application/json
{ }

providers

List providers

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
orgId
required
integer
projectIds
string

Comma-separated project ids

excludePublic
boolean
search
string
page
integer >= 1

Page number, defaults to 1

pageSize
integer >= 1

Page size, defaults to 30

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "nextPage": 0
}

Get provider by name

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "public": true,
  • "revId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get provider revision

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "number": 0,
  • "version": "string",
  • "providerId": 0,
  • "manifest": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

services

List services

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
orgId
required
integer
projectIds
string

Comma-separated project ids

search
string
page
integer >= 1

Page number, defaults to 1

pageSize
integer >= 1

Page size, defaults to 30

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "nextPage": 0
}

Get service by name

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
name
required
string
query Parameters
revNumber
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "status": "string",
  • "external": true,
  • "public": true,
  • "revId": 0,
  • "latestRevNumber": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get service revision

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "external": true,
  • "number": 0,
  • "version": "string",
  • "serviceId": 0,
  • "manifest": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

stacks

List stacks

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
orgId
required
integer
projectIds
string

Comma-separated project ids

search
string
page
integer >= 1

Page number, defaults to 1

pageSize
integer >= 1

Page size, defaults to 30

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "nextPage": 0
}

Get stack by name

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
name
required
string
query Parameters
revNumber
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "icon": "string",
  • "status": "string",
  • "public": true,
  • "revId": 0,
  • "latestRevNumber": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get stack revision

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "icon": "string",
  • "number": 0,
  • "draft": true,
  • "version": "string",
  • "stackId": 0,
  • "manifest": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

List stack services

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

backups

List backups

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
appInstanceId
integer
appServiceId
integer
databaseId
integer
databaseDbId
integer
backupName
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create backup

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
appServiceID
integer or null
databaseDBID
integer or null
backupName
string or null
integrationID
required
integer
bucket
required
string
storageClass
string or null

Responses

Request samples

Content type
application/json
{
  • "appServiceID": 0,
  • "databaseDBID": 0,
  • "backupName": "string",
  • "integrationID": 0,
  • "bucket": "string",
  • "storageClass": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

Get backup

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "status": "string",
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "databaseId": 0,
  • "databaseDbId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

imports

List imports

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
appInstanceId
integer
appServiceId
integer
databaseId
integer
databaseDbId
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create import

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
appServiceID
integer or null
databaseDBID
integer or null
required
object (ImportInput)

Responses

Request samples

Content type
application/json
{
  • "appServiceID": 0,
  • "databaseDBID": 0,
  • "import": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

Get import

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "source": "string",
  • "status": "string",
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "databaseId": 0,
  • "databaseDbId": 0,
  • "appServiceDeploymentId": 0,
  • "taskId": 0,
  • "backupId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z"
}

tasks

List tasks

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
scope
string
Enum: "project_and_org" "org_only" "user_only"
orgId
integer
projectIds
string

Comma-separated project ids

withoutOrigin
boolean
statuses
string

Comma-separated task statuses

search
string
appId
integer
appInstanceId
integer
stackId
integer
databaseId
integer
clusterId
integer
serviceId
integer
integrationId
integer
providerId
integer
page
integer >= 1

Page number, defaults to 1

pageSize
integer >= 1

Page size, defaults to 30

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "nextPage": 0
}

Get task

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "progress": 0,
  • "silent": true,
  • "system": true,
  • "userId": 0,
  • "orgId": 0,
  • "projectIds": [
    ],
  • "appId": 0,
  • "appInstanceId": 0,
  • "clusterId": 0,
  • "integrationId": 0,
  • "serviceId": 0,
  • "stackId": 0,
  • "providerId": 0,
  • "originTaskId": 0,
  • "spawnedTaskIds": [
    ],
  • "repeatedTaskId": 0,
  • "jobs": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z"
}

Cancel task

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

Repeat task

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
force
required
boolean

Responses

Request samples

Content type
application/json
{
  • "force": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

task-steps

Get task step logs

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "streamId": 0,
  • "lines": [
    ]
}

Get task step log URL

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

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

app-routes

List app routes

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
appInstanceId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create app route

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
appServiceID
required
integer
main
required
boolean
primary
required
boolean
port
required
integer
host
required
string
path
string or null
pathType
string or null
Enum: "PREFIX" "EXACT"
action
string or null
Enum: "BACKEND" "REDIRECT"
redirectScheme
string or null
redirectHost
string or null
redirectPath
string or null
redirectStatusCode
integer or null
letsencrypt
boolean or null
authLogin
string or null
authPassword
string or null
authID
integer or null
Array of objects (AppEndpointOptionInput)

Responses

Request samples

Content type
application/json
{
  • "appServiceID": 0,
  • "main": true,
  • "primary": true,
  • "port": 0,
  • "host": "string",
  • "path": "string",
  • "pathType": "PREFIX",
  • "action": "BACKEND",
  • "redirectScheme": "string",
  • "redirectHost": "string",
  • "redirectPath": "string",
  • "redirectStatusCode": 0,
  • "letsencrypt": true,
  • "authLogin": "string",
  • "authPassword": "string",
  • "authID": 0,
  • "options": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "host": "string",
  • "path": "string",
  • "pathType": "string",
  • "action": "string",
  • "redirectScheme": "string",
  • "redirectHost": "string",
  • "redirectPath": "string",
  • "redirectStatusCode": 0,
  • "status": "string",
  • "disabled": true,
  • "main": true,
  • "primary": true,
  • "private": true,
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "portId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lastSyncedAt": "2019-08-24T14:15:22Z"
}

Get app route

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "host": "string",
  • "path": "string",
  • "pathType": "string",
  • "action": "string",
  • "redirectScheme": "string",
  • "redirectHost": "string",
  • "redirectPath": "string",
  • "redirectStatusCode": 0,
  • "status": "string",
  • "disabled": true,
  • "main": true,
  • "primary": true,
  • "private": true,
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "portId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lastSyncedAt": "2019-08-24T14:15:22Z"
}

Update app route

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
disabled
boolean or null
main
boolean or null
primary
boolean or null
path
string or null
pathType
string or null
Enum: "PREFIX" "EXACT"
action
string or null
Enum: "BACKEND" "REDIRECT"
redirectScheme
string or null
redirectHost
string or null
redirectPath
string or null
redirectStatusCode
integer or null
Array of objects (AppEndpointOptionInput)

Responses

Request samples

Content type
application/json
{
  • "disabled": true,
  • "main": true,
  • "primary": true,
  • "path": "string",
  • "pathType": "PREFIX",
  • "action": "BACKEND",
  • "redirectScheme": "string",
  • "redirectHost": "string",
  • "redirectPath": "string",
  • "redirectStatusCode": 0,
  • "options": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "host": "string",
  • "path": "string",
  • "pathType": "string",
  • "action": "string",
  • "redirectScheme": "string",
  • "redirectHost": "string",
  • "redirectPath": "string",
  • "redirectStatusCode": 0,
  • "status": "string",
  • "disabled": true,
  • "main": true,
  • "primary": true,
  • "private": true,
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "portId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lastSyncedAt": "2019-08-24T14:15:22Z"
}

Delete app route

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

envs

List envs

Authorizations:
apiKeyHeaderaccessTokenHeader
query Parameters
orgId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create env

Authorizations:
apiKeyHeaderaccessTokenHeader
Request Body schema: application/json
required
orgId
required
integer
name
required
string
title
required
string
type
required
string

Responses

Request samples

Content type
application/json
{
  • "orgId": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get env

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update env

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
name
required
string
title
required
string
type
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete env

Authorizations:
apiKeyHeaderaccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "taskId": 0
}

Get OpenAPI YAML

Responses

Get OpenAPI JSON

Responses

Response samples

Content type
application/json
{ }