Wodby 2 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

Organizations that own projects, resources, and access scopes.

List orgs

Authorizations:

apiKeyHeader

Responses

Response samples

200
default
4XX

Content type

application/json

[{"id": 0,
"name": "string",
"title": "string",
"domain": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

Get org

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

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

Payload

Content type

application/json

{"title": "string",
"registryIntegrationId": 0,
"ciIntegrationId": 0
}

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

projects

Project containers within organizations.

List projects

Authorizations:

apiKeyHeader

query Parameters

orgId

integer

Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.

Responses

Response samples

200
default
4XX

Content type

application/json

[{"id": 0,
"name": "string",
"title": "string",
"orgId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

Create project

Authorizations:

apiKeyHeader

Request Body schema: application/json
required

orgId	integer Optional for API-key requests; defaults to the API key's organization.
name required	string
title required	string
teamIds	Array of integers
orgMembershipIds	Array of integers
role	string

Responses

Request samples

Payload

Content type

application/json

{"orgId": 0,
"name": "string",
"title": "string",
"teamIds": [0
],
"orgMembershipIds": [0
],
"role": "string"
}

Response samples

201
default
4XX

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:

apiKeyHeader

path Parameters

name

required

string

query Parameters

orgId

integer

Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.

Responses

Response samples

200
default
4XX

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

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Request Body schema: application/json
required

title

required

string

Responses

Request samples

Payload

Content type

application/json

{"title": "string"
}

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

apps

Applications and app-level configuration.

List apps

Authorizations:

apiKeyHeader

query Parameters

orgId	integer Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.
projectIds	string Comma-separated project ids
clusterApp	boolean

Responses

Response samples

200
default
4XX

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"
}
]

Create app

Authorizations:

apiKeyHeader

Request Body schema: application/json
required

orgId	integer Optional for API-key requests; defaults to the API key's organization.
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

Payload

Content type

application/json

{"orgId": 0,
"name": "string",
"title": "string",
"instanceName": "string",
"instanceTitle": "string",
"domain": "string",
"projectId": 0,
"stackRevId": 0,
"services": [{"id": 0,
"disabled": true,
"version": "string",
"buildSource": {"buildSourceType": "string",
"template": "string",
"newRepoName": "string",
"integrationId": 0,
"remoteGitRepoId": "string",
"gitRef": "string",
"gitRefType": "string"
},
"imports": [{"importName": "string",
"source": "string",
"url": "string",
"backupId": 0,
"from": {"databaseDbId": 0,
"appServiceId": 0,
"backupName": "string"
}
}
],
"volumes": [{"name": "string",
"size": 0
}
],
"integrations": [{"name": "string",
"integrationIds": [0
]
}
],
"settings": [{"name": "string",
"value": "string"
}
],
"database": {"databaseId": 0,
"databaseDbId": 0
},
"resources": {"workload": "string",
"container": "string",
"requestCPU": 0,
"requestMem": 0,
"limitCPU": 0,
"limitMem": 0
},
"scalability": {"averageCPU": 0,
"minReplicas": 0,
"maxReplicas": 0
}
}
],
"clusterId": 0,
"newCluster": {"demo": true,
"singleNode": true,
"region": "string",
"machineType": "string",
"minNodeCount": 0,
"maxNodeCount": 0
},
"envId": 0,
"ciIntegrationId": 0,
"registryIntegrationId": 0
}

Response samples

201
default
4XX

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:

apiKeyHeader

path Parameters

name

required

string

query Parameters

orgId

integer

Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Request Body schema: application/json
required

title

required

string

Responses

Request samples

Payload

Content type

application/json

{"title": "string"
}

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

app-instances

Deployable application instances.

List app instances

Authorizations:

apiKeyHeader

query Parameters

orgId	integer Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.
projectIds	string Comma-separated project ids
appId	integer
clusterId	integer
clusterApp	boolean

Responses

Response samples

200
default
4XX

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"
}
]

Create app instance

Authorizations:

apiKeyHeader

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

Payload

Content type

application/json

{"appId": 0,
"instanceName": "string",
"instanceTitle": "string",
"domain": "string",
"stackRevId": 0,
"services": [{"id": 0,
"disabled": true,
"version": "string",
"buildSource": {"buildSourceType": "string",
"template": "string",
"newRepoName": "string",
"integrationId": 0,
"remoteGitRepoId": "string",
"gitRef": "string",
"gitRefType": "string"
},
"imports": [{"importName": "string",
"source": "string",
"url": "string",
"backupId": 0,
"from": {"databaseDbId": 0,
"appServiceId": 0,
"backupName": "string"
}
}
],
"volumes": [{"name": "string",
"size": 0
}
],
"integrations": [{"name": "string",
"integrationIds": [0
]
}
],
"settings": [{"name": "string",
"value": "string"
}
],
"database": {"databaseId": 0,
"databaseDbId": 0
},
"resources": {"workload": "string",
"container": "string",
"requestCPU": 0,
"requestMem": 0,
"limitCPU": 0,
"limitMem": 0
},
"scalability": {"averageCPU": 0,
"minReplicas": 0,
"maxReplicas": 0
}
}
],
"clusterId": 0,
"newCluster": {"demo": true,
"singleNode": true,
"region": "string",
"machineType": "string",
"minNodeCount": 0,
"maxNodeCount": 0
},
"envId": 0,
"ciIntegrationId": 0,
"registryIntegrationId": 0
}

Response samples

201
default
4XX

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:

apiKeyHeader

path Parameters

appName required	string
instanceName required	string

query Parameters

orgId

integer

Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Request Body schema: application/json
required

title

required

string

Responses

Request samples

Payload

Content type

application/json

{"title": "string"
}

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

query Parameters

force

boolean

Default: false

Responses

Response samples

200
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

app-services

Runtime services that belong to app instances.

List app services

Authorizations:

apiKeyHeader

query Parameters

appInstanceId

required

integer

Responses

Response samples

200
default
4XX

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"
}
]

Get app service

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

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

Payload

Content type

application/json

{"replicas": 0,
"version": "string",
"disabled": true,
"main": true,
"buildSource": {"buildSourceType": "string",
"template": "string",
"newRepoName": "string",
"integrationId": 0,
"remoteGitRepoId": "string",
"gitRef": "string",
"gitRefType": "string"
}
}

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id required	integer
name required	string

Responses

Response samples

201
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

app-deployments

Deployment records and deployment actions.

List app deployments

Authorizations:

apiKeyHeader

query Parameters

appInstanceId required	integer
page	integer >= 1 Page number, defaults to 1
pageSize	integer >= 1 Page size, defaults to 30

Responses

Response samples

200
default
4XX

Content type

application/json

{"items": [{"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"
}
],
"totalCount": 0,
"nextPage": 0
}

Create deployment

Authorizations:

apiKeyHeader

Request Body schema: application/json
required

required	Array of objects (AppServiceDeploymentRequest)
skipRollback	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"services": [{"appServiceId": 0,
"appServiceBuildId": 0,
"skipPostDeployment": true,
"force": true
}
],
"skipRollback": true
}

Response samples

201
default
4XX

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:

apiKeyHeaderciAccessTokenHeader

Request Body schema: application/json
required

appBuildId required	integer
required	Array of objects (ServiceDeploymentInput)
skipPostDeployment required	boolean

Responses

Request samples

Payload

Content type

application/json

{"appBuildId": 0,
"services": [{"name": "string",
"image": "string"
}
],
"skipPostDeployment": true
}

Response samples

201
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

201
default
4XX

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

Build records and CI build ingestion.

List app builds

Authorizations:

apiKeyHeader

query Parameters

appInstanceId required	integer
page	integer >= 1 Page number, defaults to 1
pageSize	integer >= 1 Page size, defaults to 30

Responses

Response samples

200
default
4XX

Content type

application/json

{"items": [{"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"
}
],
"totalCount": 0,
"nextPage": 0
}

Create build

Authorizations:

apiKeyHeader

Request Body schema: application/json
required

appServiceIds

required

Array of integers non-empty

Responses

Request samples

Payload

Content type

application/json

{"appServiceIds": [0
]
}

Response samples

201
default
4XX

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"
}
]

Create build from CI

Authorizations:

apiKeyHeader

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

Payload

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

201
default
4XX

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:

apiKeyHeaderciAccessTokenHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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 config

Authorizations:

apiKeyHeaderciAccessTokenHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"registryHost": "string",
"registryRepository": "string",
"services": [{"name": "string",
"title": "string",
"managed": true,
"main": true,
"image": "string",
"dockerfile": "string",
"dockerignore": "string",
"args": [{"name": "string",
"value": "string",
"secret": true
}
]
}
]
}

Get Docker registry credentials for build

Authorizations:

apiKeyHeaderciAccessTokenHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"username": "string",
"password": "string"
}

Deploy build

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

201
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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

Kubernetes clusters connected to or managed by Wodby.

List clusters

Authorizations:

apiKeyHeader

query Parameters

orgId	integer Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.
projectIds	string Comma-separated project ids
integrationId	integer

Responses

Response samples

200
default
4XX

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"
}
]

Create cluster

Authorizations:

apiKeyHeader

Request Body schema: application/json
required

orgId	integer Optional for API-key requests; defaults to the API key's organization.
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

Payload

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

201
default
4XX

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 by name

Authorizations:

apiKeyHeader

path Parameters

name

required

string

query Parameters

orgId

integer

Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Request Body schema: application/json
required

title

required

string

Responses

Request samples

Payload

Content type

application/json

{"title": "string"
}

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

query Parameters

force

boolean

Default: false

Responses

Response samples

200
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

databases

Database instances managed through provider integrations.

List databases

Authorizations:

apiKeyHeader

query Parameters

orgId	integer Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.
projectIds	string Comma-separated project ids
kind	string

Responses

Response samples

200
default
4XX

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"
}
]

Create database

Authorizations:

apiKeyHeader

Request Body schema: application/json
required

orgId	integer Optional for API-key requests; defaults to the API key's organization.
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

Payload

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

201
default
4XX

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 by name

Authorizations:

apiKeyHeader

path Parameters

name

required

string

query Parameters

orgId

integer

Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Request Body schema: application/json
required

title

required

string

Responses

Request samples

Payload

Content type

application/json

{"title": "string"
}

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

integrations

Connected provider accounts and credentials.

List integrations

Authorizations:

apiKeyHeader

query Parameters

orgId	integer Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.
projectIds	string Comma-separated project ids
labels	string Comma-separated labels

Responses

Response samples

200
default
4XX

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"
}
]

Create integration

Authorizations:

apiKeyHeader

Request Body schema: application/json
required

orgId	integer Optional for API-key requests; defaults to the API key's organization.
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

Payload

Content type

application/json

{"orgId": 0,
"providerId": 0,
"name": "string",
"title": "string",
"kinds": ["string"
],
"auth": "string",
"projectId": 0,
"fieldsInput": [{"name": "string",
"value": "string"
}
],
"scope": "string"
}

Response samples

201
default
4XX

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:

apiKeyHeader

path Parameters

name

required

string

query Parameters

orgId

integer

Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

[{"name": "string",
"title": "string"
}
]

List remote Git repositories

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

[{"id": "string",
"name": "string"
}
]

List remote Git repository branches

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

query Parameters

remoteGitRepoId

required

string

Responses

Response samples

200
default
4XX

Content type

application/json

["string"
]

List remote Git repository tags

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

query Parameters

remoteGitRepoId

required

string

Responses

Response samples

200
default
4XX

Content type

application/json

["string"
]

List Kubernetes regions

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

[{ }
]

List Kubernetes zones

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

[{ }
]

List Kubernetes machine types

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

query Parameters

location

required

string

Responses

Response samples

200
default
4XX

Content type

application/json

[{ }
]

List Kubernetes versions

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

query Parameters

location

required

string

Responses

Response samples

200
default
4XX

Content type

application/json

[{"name": "string",
"title": "string"
}
]

Get Kubernetes settings

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{ }

List storage buckets

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

["string"
]

List storage classes

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

["string"
]

Get integration

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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"
}

Update integration

Authorizations:

apiKeyHeader

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

Payload

Content type

application/json

{"title": "string",
"name": "string",
"kinds": ["string"
],
"scope": "string",
"fieldsInput": [{"name": "string",
"value": "string"
}
]
}

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

integration-kinds

Provider capability metadata and option lists.

List database types

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

[{"name": "string",
"title": "string",
"kind": "string"
}
]

List database regions

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

query Parameters

dbType required	string
version required	string
ha	boolean Default: false

Responses

Response samples

200
default
4XX

Content type

application/json

[{ }
]

List database versions

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

query Parameters

dbType

required

string

Responses

Response samples

200
default
4XX

Content type

application/json

[{"name": "string",
"title": "string"
}
]

List database machine types

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

query Parameters

dbType required	string
version required	string
ha	boolean Default: false
region	string
zone	string

Responses

Response samples

200
default
4XX

Content type

application/json

[{ }
]

Get database settings

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

query Parameters

dbType

required

string

Responses

Response samples

200
default
4XX

Content type

application/json

{ }

providers

Provider catalog entries and revisions.

List providers

Authorizations:

apiKeyHeader

query Parameters

orgId	integer Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.
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

200
default
4XX

Content type

application/json

{"items": [{"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"
}
],
"totalCount": 0,
"nextPage": 0
}

Get provider by name

Authorizations:

apiKeyHeader

path Parameters

name

required

string

Responses

Response samples

200
default
4XX

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

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"id": 0,
"name": "string",
"title": "string",
"number": 0,
"version": "string",
"providerId": 0,
"manifest": { },
"createdAt": "2019-08-24T14:15:22Z"
}

services

Service catalog entries and service options.

List services

Authorizations:

apiKeyHeader

query Parameters

orgId	integer Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.
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

200
default
4XX

Content type

application/json

{"items": [{"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"
}
],
"totalCount": 0,
"nextPage": 0
}

Get service by name

Authorizations:

apiKeyHeader

path Parameters

name

required

string

query Parameters

revNumber

integer

Responses

Response samples

200
default
4XX

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

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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"
}

List service link candidates

Authorizations:

apiKeyHeader

path Parameters

name

required

string

Responses

Response samples

200
default
4XX

Content type

application/json

[{ }
]

Get service revision

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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

Stack catalog entries and stack revisions.

List stacks

Authorizations:

apiKeyHeader

query Parameters

orgId	integer Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.
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

200
default
4XX

Content type

application/json

{"items": [{"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"
}
],
"totalCount": 0,
"nextPage": 0
}

Get stack by name

Authorizations:

apiKeyHeader

path Parameters

name

required

string

query Parameters

revNumber

integer

Responses

Response samples

200
default
4XX

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

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

[{"id": 0,
"name": "string",
"title": "string",
"type": "string",
"main": true,
"disabled": true,
"required": true,
"replicas": 0,
"serviceRevId": 0,
"serviceRevName": "string",
"serviceRevTitle": "string",
"serviceRevVersion": "string",
"buildSourceIntegrationId": 0,
"buildSourceRemoteRepoId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

backups

Backup records and backup creation.

List backups

Authorizations:

apiKeyHeader

query Parameters

appInstanceId	integer
appServiceId	integer
databaseId	integer
databaseDbId	integer
backupName	string

Responses

Response samples

200
default
4XX

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"
}
]

Create backup

Authorizations:

apiKeyHeader

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

Payload

Content type

application/json

{"appServiceId": 0,
"databaseDbId": 0,
"backupName": "string",
"integrationId": 0,
"bucket": "string",
"storageClass": "string"
}

Response samples

201
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

Get backup

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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

Import records and import creation.

List imports

Authorizations:

apiKeyHeader

query Parameters

appInstanceId	integer
appServiceId	integer
databaseId	integer
databaseDbId	integer

Responses

Response samples

200
default
4XX

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"
}
]

Create import

Authorizations:

apiKeyHeader

Request Body schema: application/json
required

appServiceId	integer or null
databaseDbId	integer or null
required	object (ImportInput)

Responses

Request samples

Payload

Content type

application/json

{"appServiceId": 0,
"databaseDbId": 0,
"import": {"importName": "string",
"source": "string",
"url": "string",
"backupId": 0,
"from": {"databaseDbId": 0,
"appServiceId": 0,
"backupName": "string"
}
}
}

Response samples

201
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

Get import

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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

User-visible task records and task actions.

List tasks

Authorizations:

apiKeyHeader

query Parameters

scope	string Enum: "project_and_org" "org_only" "user_only"
orgId	integer Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.
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

200
default
4XX

Content type

application/json

{"items": [{"id": 0,
"name": "string",
"title": "string",
"status": "string",
"progress": 0,
"silent": true,
"system": true,
"userId": 0,
"orgId": 0,
"projectIds": [0
],
"appId": 0,
"appInstanceId": 0,
"clusterId": 0,
"integrationId": 0,
"serviceId": 0,
"stackId": 0,
"providerId": 0,
"originTaskId": 0,
"spawnedTaskIds": [0
],
"repeatedTaskId": 0,
"jobs": [{"id": 0,
"name": "string",
"title": "string",
"status": "string",
"after": ["string"
],
"timeout": 0,
"isSystem": true,
"statusTitle": "string",
"steps": [{"id": 0,
"name": "string",
"status": "string",
"logStatus": "string",
"isSystem": true,
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0,
"nextPage": 0
}

Get task

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"id": 0,
"name": "string",
"title": "string",
"status": "string",
"progress": 0,
"silent": true,
"system": true,
"userId": 0,
"orgId": 0,
"projectIds": [0
],
"appId": 0,
"appInstanceId": 0,
"clusterId": 0,
"integrationId": 0,
"serviceId": 0,
"stackId": 0,
"providerId": 0,
"originTaskId": 0,
"spawnedTaskIds": [0
],
"repeatedTaskId": 0,
"jobs": [{"id": 0,
"name": "string",
"title": "string",
"status": "string",
"after": ["string"
],
"timeout": 0,
"isSystem": true,
"statusTitle": "string",
"steps": [{"id": 0,
"name": "string",
"status": "string",
"logStatus": "string",
"isSystem": true,
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z"
}
],
"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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

Repeat task

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Request Body schema: application/json
required

force

required

boolean

Responses

Request samples

Payload

Content type

application/json

{"force": true
}

Response samples

201
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

task-steps

Task step logs and log URLs.

Get task step logs

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"streamId": 0,
"lines": [{"sequenceId": 0,
"level": "string",
"message": "string"
}
]
}

Get task step log URL

Authorizations:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"url": "string"
}

app-routes

HTTP routing rules for app instances.

List app routes

Authorizations:

apiKeyHeader

query Parameters

appInstanceId

required

integer

Responses

Response samples

200
default
4XX

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"
}
]

Create app route

Authorizations:

apiKeyHeader

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

Payload

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": [{"name": "string",
"value": "string"
}
]
}

Response samples

201
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

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

Payload

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": [{"name": "string",
"value": "string"
}
]
}

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

envs

Organization-level environment definitions.

List envs

Authorizations:

apiKeyHeader

query Parameters

orgId

integer

Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.

Responses

Response samples

200
default
4XX

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"
}
]

Create env

Authorizations:

apiKeyHeader

Request Body schema: application/json
required

orgId	integer Optional for API-key requests; defaults to the API key's organization.
name required	string
title required	string
type required	string

Responses

Request samples

Payload

Content type

application/json

{"orgId": 0,
"name": "string",
"title": "string",
"type": "string"
}

Response samples

201
default
4XX

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 by name

Authorizations:

apiKeyHeader

path Parameters

name

required

string

query Parameters

orgId

integer

Optional for API-key requests; defaults to the API key's organization. If provided, it must match the key's organization.

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Request Body schema: application/json
required

name required	string
title required	string
type required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"title": "string",
"type": "string"
}

Response samples

200
default
4XX

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:

apiKeyHeader

path Parameters

id

required

integer

Responses

Response samples

200
default
4XX

Content type

application/json

{"success": true,
"taskId": 0
}

Get OpenAPI YAML

Responses

Response samples

default
4XX

Content type

application/json

{"message": "string"
}

Get OpenAPI JSON

Responses

Response samples

200
default
4XX

Content type

application/json

{ }

Wodby 2 Public API (1.0.0)

orgs

List orgs

Authorizations:

Responses

Response samples

Get org

Authorizations:

path Parameters

Responses

Response samples

Update org

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete org

Authorizations:

path Parameters

Responses

Response samples

projects

List projects

Authorizations:

query Parameters

Responses

Response samples

Create project

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get project by name

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get project

Authorizations:

path Parameters

Responses

Response samples

Update project

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete project

Authorizations:

path Parameters

Responses

Response samples

apps

List apps

Authorizations:

query Parameters

Responses

Response samples

Create app

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get app by name

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get app

Authorizations:

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required