API docs by Redocly

Wodby 2 Public API (1.0.0)

Download OpenAPI specification:

License: Proprietary Terms of Service

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

user

Authenticated user account profile.

Get current user

Returns the authenticated user account.

Authorizations:
apiKeyHeader

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "orgs": [
    ],
  • "twofa": true,
  • "defaultOrg": {
    },
  • "defaultProjects": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update current user

Updates the authenticated user's basic profile and returns the updated account.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
name
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "orgs": [
    ],
  • "twofa": true,
  • "defaultOrg": {
    },
  • "defaultProjects": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

orgs

Organizations that own projects, resources, and access scopes.

List orgs

Returns orgs matching the request filters.

Authorizations:
apiKeyHeader

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get org

Returns the org identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

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

Updates the org and returns the updated resource.

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

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

org-memberships

Organization users, invitations, roles, and membership status.

List org memberships

Returns org memberships matching the request filters.

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

Content type
application/json
[
  • {
    }
]

Get org membership

Returns the org membership identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "userId": 0,
  • "user": {
    },
  • "email": "string",
  • "orgId": 0,
  • "role": "string",
  • "status": "string",
  • "joinedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

projects

Project containers within organizations.

List projects

Returns projects matching the request filters.

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

Content type
application/json
[
  • {
    }
]

Create project

Creates a project and returns the created resource.

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

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

Returns the project identified 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

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

Returns the project identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
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

Updates the project and returns the updated resource.

Authorizations:
apiKeyHeader
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

Deletes the project and returns the operation result.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

apps

Applications and app-level configuration.

List apps

Returns apps matching the request filters.

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

Content type
application/json
[
  • {
    }
]

Create app

Creates an app and returns the created resource.

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
string

Defaults to name when omitted.

instanceName
required
string
instanceTitle
string

Defaults to instanceName when omitted.

domain
string

Defaults to instanceName.name.orgDomain when omitted.

projectId
integer or null
stackRevId
required
integer
Array of objects (NewAppServiceInput)

Defaults to the stack revision's service defaults when omitted.

clusterId
integer or null
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,
  • "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

Returns the app identified 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

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

Returns the app identified by the request path.

Authorizations:
apiKeyHeader
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

Updates the app and returns the updated resource.

Authorizations:
apiKeyHeader
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

Deletes the app and returns the operation result.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

app-instances

Deployable application instances.

List app instances

Returns app instances matching the request filters.

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

Content type
application/json
[
  • {
    }
]

Create app instance

Creates an app instance and returns the created resource.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
appId
required
integer
instanceName
required
string
instanceTitle
string

Defaults to instanceName when omitted.

domain
string

Defaults to instanceName.appName.orgDomain when omitted.

stackRevId
required
integer
Array of objects (NewAppServiceInput)

Defaults to the stack revision's service defaults when omitted.

clusterId
integer or null
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,
  • "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,
  • "stackId": 0,
  • "stackRevId": 0,
  • "stackName": "string",
  • "stackTitle": "string",
  • "stackIcon": "string",
  • "stackRevNumber": 0,
  • "stackVersion": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get app instance by app and instance name

Returns the app instance identified 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

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "mainDomain": "string",
  • "appId": 0,
  • "clusterId": 0,
  • "envId": 0,
  • "stackId": 0,
  • "stackRevId": 0,
  • "stackName": "string",
  • "stackTitle": "string",
  • "stackIcon": "string",
  • "stackRevNumber": 0,
  • "stackVersion": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get app instance

Returns the app instance identified by the request path.

Authorizations:
apiKeyHeader
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,
  • "stackId": 0,
  • "stackRevId": 0,
  • "stackName": "string",
  • "stackTitle": "string",
  • "stackIcon": "string",
  • "stackRevNumber": 0,
  • "stackVersion": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update app instance

Updates the app instance and returns the updated resource.

Authorizations:
apiKeyHeader
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,
  • "stackId": 0,
  • "stackRevId": 0,
  • "stackName": "string",
  • "stackTitle": "string",
  • "stackIcon": "string",
  • "stackRevNumber": 0,
  • "stackVersion": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete app instance

Deletes the app instance and returns the operation result.

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

Responses

Response samples

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

Update app instance settings

Updates app instance settings and returns the updated app instance.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
object (AppInstanceAutoStackUpgradeSettingsInput)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "mainDomain": "string",
  • "appId": 0,
  • "clusterId": 0,
  • "envId": 0,
  • "stackId": 0,
  • "stackRevId": 0,
  • "stackName": "string",
  • "stackTitle": "string",
  • "stackIcon": "string",
  • "stackRevNumber": 0,
  • "stackVersion": "string",
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Upgrade app instance stack

Upgrades an app instance stack using the selected upgrade sections.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
versions
required
boolean
replicas
required
boolean
resources
required
boolean
integrations
required
boolean
services
required
boolean
settings
required
boolean
links
required
boolean
tokens
required
boolean
configs
required
boolean
cron
required
boolean
volumes
required
boolean
main
required
boolean

Responses

Request samples

Content type
application/json
{
  • "versions": true,
  • "replicas": true,
  • "resources": true,
  • "integrations": true,
  • "services": true,
  • "settings": true,
  • "links": true,
  • "tokens": true,
  • "configs": true,
  • "cron": true,
  • "volumes": true,
  • "main": true
}

Response samples

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

app-services

Runtime services that belong to app instances.

List app services

Returns app services matching the request filters.

Authorizations:
apiKeyHeader
query Parameters
appInstanceId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get app service

Returns the app service identified by the request path.

Authorizations:
apiKeyHeader
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

Updates the app service and returns the updated resource.

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

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

Runs the named action for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
name
required
string

Responses

Response samples

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

Create app service log stream

Creates a log stream for an app service container and returns the stream id.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
workload
string or null
container
string or null

Responses

Request samples

Content type
application/json
{
  • "workload": "string",
  • "container": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

List app service env vars

Returns environment variables configured for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create app service env var

Creates an environment variable for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
workload
string or null
container
string or null
name
required
string
value
required
string
secret
required
boolean
runtime
boolean or null
build
boolean or null

Responses

Request samples

Content type
application/json
{
  • "workload": "string",
  • "container": "string",
  • "name": "string",
  • "value": "string",
  • "secret": true,
  • "runtime": true,
  • "build": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "appServiceId": 0,
  • "workload": "string",
  • "container": "string",
  • "name": "string",
  • "value": "string",
  • "valueSecretId": 0,
  • "runtime": true,
  • "build": true,
  • "envType": "string",
  • "source": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Update app service env var

Updates an app service environment variable.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
value
string or null
secret
required
boolean
runtime
boolean or null
build
boolean or null

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "secret": true,
  • "runtime": true,
  • "build": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "appServiceId": 0,
  • "workload": "string",
  • "container": "string",
  • "name": "string",
  • "value": "string",
  • "valueSecretId": 0,
  • "runtime": true,
  • "build": true,
  • "envType": "string",
  • "source": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete app service env var

Deletes an app service environment variable.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List app service Helm values

Returns Helm values configured for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create app service Helm value

Creates a Helm value override for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
name
required
string
value
required
string
secret
required
boolean

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "appServiceId": 0,
  • "name": "string",
  • "value": "string",
  • "valueSecretId": 0,
  • "source": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Update app service Helm value

Updates an app service Helm value override.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
value
required
string
secret
required
boolean

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "secret": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "appServiceId": 0,
  • "name": "string",
  • "value": "string",
  • "valueSecretId": 0,
  • "source": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete app service Helm value

Deletes an app service Helm value override.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List app service tokens

Returns tokens configured for an app service without revealing secret values.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create app service token

Creates a token for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
name
required
string
value
required
string
secret
required
boolean

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "appServiceId": 0,
  • "name": "string",
  • "value": "string",
  • "valueSecretId": 0,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Update app service token

Updates an app service token value or secret flag.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
value
required
string
secret
required
boolean

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "secret": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "appServiceId": 0,
  • "name": "string",
  • "value": "string",
  • "valueSecretId": 0,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete app service token

Deletes an app service token.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List app service annotations

Returns annotations configured for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create app service annotation

Creates an annotation for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
name
required
string
value
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "appServiceId": 0,
  • "name": "string",
  • "value": "string",
  • "envType": "string",
  • "source": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete app service annotation

Deletes an app service annotation.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List app service integrations

Returns integration links configured for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create app service integration

Links an integration to an app service integration slot.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
name
required
string
integrationId
required
integer

Responses

Request samples

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

Response samples

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

Delete app service integration

Removes an integration link from an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List app service settings

Returns settings configured for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set app service setting

Sets a named setting value for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
name
required
string
Request Body schema: application/json
required
value
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "appServiceId": 0,
  • "name": "string",
  • "value": "string",
  • "var": "string",
  • "runtime": true,
  • "build": true,
  • "fromSettingId": 0
}

List app service configs

Returns config overrides for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set app service config

Sets or disables a named config override for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
name
required
string
Request Body schema: application/json
required
config
string or null
disabled
boolean or null

Responses

Request samples

Content type
application/json
{
  • "config": "string",
  • "disabled": true
}

Response samples

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

List app service containers

Returns container resource settings for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set app service resources

Sets CPU and memory requests or limits for an app service container.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
workload
string or null
container
string or null
requestCPU
integer or null
requestMem
integer or null
limitCPU
integer or null
limitMem
integer or null

Responses

Request samples

Content type
application/json
{
  • "workload": "string",
  • "container": "string",
  • "requestCPU": 0,
  • "requestMem": 0,
  • "limitCPU": 0,
  • "limitMem": 0
}

Response samples

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

Update app service database references

Updates the database DB and user references used by an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
databaseDbId
integer or null
databaseUserId
integer or null

Responses

Request samples

Content type
application/json
{
  • "databaseDbId": 0,
  • "databaseUserId": 0
}

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

List app service cron schedules

Returns cron schedules configured for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create app service cron schedule

Creates a cron schedule for an app service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
title
required
string
crontab
required
string
command
required
string
workload
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "crontab": "string",
  • "command": "string",
  • "workload": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "appServiceId": 0,
  • "title": "string",
  • "crontab": "string",
  • "command": "string",
  • "workload": "string",
  • "disabled": true,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update app service cron schedule

Updates an app service cron schedule.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
disabled
boolean or null
title
string or null
crontab
string or null
command
string or null
workload
string or null

Responses

Request samples

Content type
application/json
{
  • "disabled": true,
  • "title": "string",
  • "crontab": "string",
  • "command": "string",
  • "workload": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "appServiceId": 0,
  • "title": "string",
  • "crontab": "string",
  • "command": "string",
  • "workload": "string",
  • "disabled": true,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete app service cron schedule

Deletes an app service cron schedule.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

Run app service cron schedule

Runs an app service cron schedule immediately and returns the created task.

Authorizations:
apiKeyHeader
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,
  • "user": {
    },
  • "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"
}

List app service cron jobs

Returns app service cron jobs matching the request filters.

Authorizations:
apiKeyHeader
query Parameters
appInstanceId
integer
appServiceId
integer
scheduleId
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 app service cron job

Returns the app service cron job identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "appServiceId": 0,
  • "scheduleId": 0,
  • "taskId": 0,
  • "title": "string",
  • "command": "string",
  • "status": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Start log stream

Starts an existing log stream.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

Keep log stream alive

Extends an existing log stream lease.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

Stop log stream

Stops an existing log stream.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

app-deployments

Deployment records and deployment actions.

List app deployments

Returns app deployments matching the request filters.

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

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

Create deployment

Creates a deployment and returns the created resource.

Authorizations:
apiKeyHeader
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",
  • "rollbackStatus": "not_attempted",
  • "skipRollback": true,
  • "appInstanceId": 0,
  • "builds": [
    ],
  • "taskId": 0,
  • "task": {
    },
  • "appServiceDeployments": [
    ],
  • "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

Creates a deployment from a CI workflow request.

Authorizations:
apiKeyHeaderciAccessTokenHeader
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",
  • "rollbackStatus": "not_attempted",
  • "skipRollback": true,
  • "appInstanceId": 0,
  • "builds": [
    ],
  • "taskId": 0,
  • "task": {
    },
  • "appServiceDeployments": [
    ],
  • "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

Returns the deployment identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "rollbackStatus": "not_attempted",
  • "skipRollback": true,
  • "appInstanceId": 0,
  • "builds": [
    ],
  • "taskId": 0,
  • "task": {
    },
  • "appServiceDeployments": [
    ],
  • "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

Creates a redeployment task for an existing deployment.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "rollbackStatus": "not_attempted",
  • "skipRollback": true,
  • "appInstanceId": 0,
  • "builds": [
    ],
  • "taskId": 0,
  • "task": {
    },
  • "appServiceDeployments": [
    ],
  • "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

Returns app builds matching the request filters.

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

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

Create build

Creates a build and returns the created resource.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
appServiceIds
required
Array of integers non-empty

Responses

Request samples

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

Response samples

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

Create build from CI

Creates a build from a CI workflow request.

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

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,
  • "taskId": 0,
  • "task": {
    },
  • "appServiceBuilds": [
    ],
  • "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

Returns the build identified by the request path.

Authorizations:
apiKeyHeaderciAccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "taskId": 0,
  • "task": {
    },
  • "appServiceBuilds": [
    ],
  • "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

Returns CI build configuration for the app build.

Authorizations:
apiKeyHeaderciAccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "registryHost": "string",
  • "registryRepository": "string",
  • "services": [
    ]
}

Get Docker registry credentials for build

Returns Docker registry credentials for the app build.

Authorizations:
apiKeyHeaderciAccessTokenHeader
path Parameters
id
required
integer

Responses

Response samples

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

Deploy build

Creates a deployment from the completed app build.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "rollbackStatus": "not_attempted",
  • "skipRollback": true,
  • "appInstanceId": 0,
  • "builds": [
    ],
  • "taskId": 0,
  • "task": {
    },
  • "appServiceDeployments": [
    ],
  • "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-ports

Network ports exposed by app services and app endpoints.

List app ports

Returns app ports matching the request filters.

Authorizations:
apiKeyHeader
query Parameters
appInstanceId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get app port

Returns the app port identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "protocol": "string",
  • "number": 0,
  • "publicPort": 0,
  • "private": true,
  • "appEndpointId": 0,
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

app-routes

HTTP routing rules for app instances.

List app routes

Returns app routes matching the request filters.

Authorizations:
apiKeyHeader
query Parameters
appInstanceId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create app route

Creates an app route and returns the created resource.

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

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,
  • "cert": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lastSyncedAt": "2019-08-24T14:15:22Z"
}

Get app route

Returns the app route identified by the request path.

Authorizations:
apiKeyHeader
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,
  • "cert": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lastSyncedAt": "2019-08-24T14:15:22Z"
}

Update app route

Updates the app route and returns the updated resource.

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

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,
  • "cert": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lastSyncedAt": "2019-08-24T14:15:22Z"
}

Delete app route

Deletes the app route and returns the operation result.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

certs

TLS certificate metadata for routes, app services, app instances, and databases.

List certs

Returns certificate metadata for an organization.

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

Content type
application/json
[
  • {
    }
]

Get cert

Returns certificate metadata identified by the request path within the requested organization.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
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

Content type
application/json
{
  • "id": 0,
  • "issuer": "string",
  • "keyType": "string",
  • "keyLength": 0,
  • "status": "string",
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "databaseId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "renewsAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

clusters

Kubernetes clusters connected to or managed by Wodby.

List clusters

Returns clusters matching the request filters.

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

Content type
application/json
[
  • {
    }
]

Create cluster

Creates a cluster and returns the created resource.

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

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,
  • "demo": true,
  • "wodby": true,
  • "k3s": true,
  • "singleNode": true,
  • "version": "string",
  • "infraVersion": "string",
  • "minNodeCount": 0,
  • "maxNodeCount": 0,
  • "lastNodesReady": 0,
  • "lastNodesTotal": 0,
  • "region": "string",
  • "zone": "string",
  • "ips": [
    ],
  • "hostname": "string",
  • "integrationId": 0,
  • "orgId": 0,
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get cluster by name

Returns the cluster identified 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

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "serverless": true,
  • "demo": true,
  • "wodby": true,
  • "k3s": true,
  • "singleNode": true,
  • "version": "string",
  • "infraVersion": "string",
  • "minNodeCount": 0,
  • "maxNodeCount": 0,
  • "lastNodesReady": 0,
  • "lastNodesTotal": 0,
  • "region": "string",
  • "zone": "string",
  • "ips": [
    ],
  • "hostname": "string",
  • "integrationId": 0,
  • "orgId": 0,
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get cluster

Returns the cluster identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "serverless": true,
  • "demo": true,
  • "wodby": true,
  • "k3s": true,
  • "singleNode": true,
  • "version": "string",
  • "infraVersion": "string",
  • "minNodeCount": 0,
  • "maxNodeCount": 0,
  • "lastNodesReady": 0,
  • "lastNodesTotal": 0,
  • "region": "string",
  • "zone": "string",
  • "ips": [
    ],
  • "hostname": "string",
  • "integrationId": 0,
  • "orgId": 0,
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update cluster

Updates the cluster and returns the updated resource.

Authorizations:
apiKeyHeader
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,
  • "demo": true,
  • "wodby": true,
  • "k3s": true,
  • "singleNode": true,
  • "version": "string",
  • "infraVersion": "string",
  • "minNodeCount": 0,
  • "maxNodeCount": 0,
  • "lastNodesReady": 0,
  • "lastNodesTotal": 0,
  • "region": "string",
  • "zone": "string",
  • "ips": [
    ],
  • "hostname": "string",
  • "integrationId": 0,
  • "orgId": 0,
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete cluster

Deletes the cluster and returns the operation result.

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

Responses

Response samples

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

Update cluster settings

Updates cluster settings and returns the updated cluster.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
object (ClusterAutoInfrastructureUpgradeSettingsInput)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "serverless": true,
  • "demo": true,
  • "wodby": true,
  • "k3s": true,
  • "singleNode": true,
  • "version": "string",
  • "infraVersion": "string",
  • "minNodeCount": 0,
  • "maxNodeCount": 0,
  • "lastNodesReady": 0,
  • "lastNodesTotal": 0,
  • "region": "string",
  • "zone": "string",
  • "ips": [
    ],
  • "hostname": "string",
  • "integrationId": 0,
  • "orgId": 0,
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Upgrade cluster infrastructure

Starts a cluster infrastructure upgrade task and returns the task identifier.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

Upgrade cluster infrastructure app stacks

Starts a cluster infrastructure app stack upgrade task and returns the task identifier.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

databases

Database instances managed through provider integrations.

List databases

Returns databases matching the request filters.

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

Content type
application/json
[
  • {
    }
]

Create database

Creates a database and returns the created resource.

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

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,
  • "appServiceId": 0,
  • "envId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get database by name

Returns the database identified 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

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

Get database

Returns the database identified by the request path.

Authorizations:
apiKeyHeader
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,
  • "appServiceId": 0,
  • "envId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update database

Updates the database and returns the updated resource.

Authorizations:
apiKeyHeader
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,
  • "appServiceId": 0,
  • "envId": 0,
  • "orgId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete database

Deletes the database and returns the operation result.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List database charsets

Returns charset and default collation options supported by a database.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List database DBs

Returns DBs that belong to a database.

Authorizations:
apiKeyHeader
query Parameters
databaseId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create database DB

Creates a DB inside a database.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
databaseId
required
integer
name
required
string
charset
string or null
collation
string or null

Responses

Request samples

Content type
application/json
{
  • "databaseId": 0,
  • "name": "string",
  • "charset": "string",
  • "collation": "string"
}

Response samples

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

Get database DB

Returns the database DB identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

Delete database DB

Deletes a database DB and returns the operation result.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List database users

Returns users that belong to a database without revealing passwords.

Authorizations:
apiKeyHeader
query Parameters
databaseId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create database user

Creates a database user and optionally grants it access to DBs.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
databaseId
required
integer
name
required
string
password
required
string
hostname
string or null
databaseDbIds
Array of integers

Responses

Request samples

Content type
application/json
{
  • "databaseId": 0,
  • "name": "string",
  • "password": "string",
  • "hostname": "string",
  • "databaseDbIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "databaseId": 0,
  • "name": "string",
  • "passwordSecretId": 0,
  • "hostname": "string",
  • "status": "string",
  • "dbs": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Update database user DB grants

Replaces the DB grants for a database user.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
databaseDbIds
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "databaseDbIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "databaseId": 0,
  • "name": "string",
  • "passwordSecretId": 0,
  • "hostname": "string",
  • "status": "string",
  • "dbs": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete database user

Deletes a database user and returns the operation result.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

integrations

Connected provider accounts and credentials.

List integrations

Returns integrations matching the request filters.

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

Content type
application/json
[
  • {
    }
]

Create integration

Creates an integration and returns the created resource.

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

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

Returns the integration identified 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

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

Returns integration scopes matching the request filters.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List remote Git repositories

Returns remote Git repositories matching the request filters.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List remote Git repository branches

Returns remote Git repository branches matching the request filters.

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

Responses

Response samples

Content type
application/json
[
  • "string"
]

List remote Git repository tags

Returns remote Git repository tags matching the request filters.

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

Responses

Response samples

Content type
application/json
[
  • "string"
]

List Kubernetes regions

Returns Kubernetes regions matching the request filters.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • { }
]

List Kubernetes zones

Returns Kubernetes zones matching the request filters.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • { }
]

List Kubernetes machine types

Returns Kubernetes machine types matching the request filters.

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

Responses

Response samples

Content type
application/json
[
  • { }
]

List Kubernetes versions

Returns Kubernetes versions matching the request filters.

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Kubernetes settings

Returns the Kubernetes settings identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{ }

List storage buckets

Returns storage buckets matching the request filters.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • "string"
]

List storage classes

Returns storage classes matching the request filters.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get integration

Returns the integration identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
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"
}

Update integration

Updates the integration and returns the updated resource.

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

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

Deletes the integration and returns the operation result.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

integration-kinds

Provider capability metadata and option lists.

List database types

Returns database types matching the request filters.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List database regions

Returns database regions matching the request filters.

Authorizations:
apiKeyHeader
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

Returns database versions matching the request filters.

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List database machine types

Returns database machine types matching the request filters.

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

Content type
application/json
[
  • { }
]

Get database settings

Returns the database settings identified by the request path.

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

Responses

Response samples

Content type
application/json
{ }

providers

Provider catalog entries and revisions.

List providers

Returns providers matching the request filters.

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

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

Get provider by name

Returns the provider identified by name.

Authorizations:
apiKeyHeader
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

Returns the provider identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

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

Returns the provider revision identified by the request path.

Authorizations:
apiKeyHeader
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"
}

helm-charts

Helm chart analysis and Wodby manifest scaffolding.

Inspect Helm chart

Renders a Helm chart with optional values and returns detected Kubernetes resources, warnings, and chart metadata.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
sourceName
string

Optional chart source name to use in generated Wodby manifests.

source
string

Optional Helm repository or OCI source URL.

chart
required
string

Helm chart reference, such as bitnami/redis, oci://registry.example.com/chart, a chart archive URL, or a server-local chart path.

version
string

Optional Helm chart version.

release
string

Optional Helm release name used for rendering analysis.

namespace
string

Optional Kubernetes namespace used for rendering analysis.

object (GenericObject)
valuesYaml
string

Optional Helm values YAML. Use either values or valuesYaml, not both.

Responses

Request samples

Content type
application/json
{
  • "sourceName": "string",
  • "source": "string",
  • "chart": "string",
  • "version": "string",
  • "release": "string",
  • "namespace": "string",
  • "values": { },
  • "valuesYaml": "string"
}

Response samples

Content type
application/json
{
  • "chart": {
    },
  • "release": "string",
  • "namespace": "string",
  • "resourceCount": 0,
  • "workloads": [
    ],
  • "services": [
    ],
  • "volumeClaims": [
    ],
  • "crds": [
    ],
  • "clusterResources": [
    ],
  • "hooks": [
    ],
  • "unsupportedKinds": [
    ],
  • "warnings": [
    ]
}

services

Service catalog entries and service options.

List services

Returns services matching the request filters.

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

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

Import services from Git

Starts a task that imports services from a Git repository.

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
remoteGitRepoId
required
string
gitRef
required
string
gitRefType
required
string
object (GitAutoUpdateSettingsInput)

Responses

Request samples

Content type
application/json
{
  • "orgId": 0,
  • "projectId": 0,
  • "integrationId": 0,
  • "remoteGitRepoId": "string",
  • "gitRef": "string",
  • "gitRefType": "string",
  • "autoUpdate": {
    }
}

Response samples

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

Validate service manifest

Validates a Wodby service manifest without creating a service.

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
version
string

Optional revision version label for the generated non-Git resource.

manifestYaml
required
string

Complete Wodby service.yml or stack.yml manifest content.

object

Optional referenced file contents keyed by manifest-relative path, for example Dockerfile or configs/app.conf.

Responses

Request samples

Content type
application/json
{
  • "orgId": 0,
  • "projectId": 0,
  • "version": "string",
  • "manifestYaml": "string",
  • "files": {
    }
}

Response samples

Content type
application/json
{
  • "valid": true,
  • "error": "string",
  • "resource": { },
  • "manifest": { }
}

Create service from manifest

Creates a non-Git Wodby service from a service manifest.

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
version
string

Optional revision version label for the generated non-Git resource.

manifestYaml
required
string

Complete Wodby service.yml or stack.yml manifest content.

object

Optional referenced file contents keyed by manifest-relative path, for example Dockerfile or configs/app.conf.

Responses

Request samples

Content type
application/json
{
  • "orgId": 0,
  • "projectId": 0,
  • "version": "string",
  • "manifestYaml": "string",
  • "files": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "status": "string",
  • "external": true,
  • "public": true,
  • "revId": 0,
  • "draftRevId": 0,
  • "latestRevNumber": 0,
  • "gitRepoId": 0,
  • "gitRepoRemoteId": "string",
  • "gitRepoRef": "string",
  • "gitRepoRefType": "string",
  • "originStackRevId": 0,
  • "originStackRevStackId": 0,
  • "originStackRevName": "string",
  • "originStackRevNumber": 0,
  • "originStackRevVersion": "string",
  • "originStackRevCreatedAt": "2019-08-24T14:15:22Z",
  • "orgId": 0,
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Scaffold service from Helm chart

Renders a Helm chart and returns a best-effort Wodby service manifest for review and validation.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
required
object (HelmChartInput)
serviceName
string

Optional generated Wodby service name.

serviceTitle
string

Optional generated Wodby service title.

serviceType
string

Optional generated Wodby service type. Defaults to service.

icon
string

Optional generated service icon.

Responses

Request samples

Content type
application/json
{
  • "chart": {
    },
  • "serviceName": "string",
  • "serviceTitle": "string",
  • "serviceType": "string",
  • "icon": "string"
}

Response samples

Content type
application/json
{
  • "analysis": {
    },
  • "manifestYaml": "string",
  • "manifest": { },
  • "warnings": [
    ]
}

Get service by name

Returns the service identified by name.

Authorizations:
apiKeyHeader
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,
  • "draftRevId": 0,
  • "latestRevNumber": 0,
  • "gitRepoId": 0,
  • "gitRepoRemoteId": "string",
  • "gitRepoRef": "string",
  • "gitRepoRefType": "string",
  • "originStackRevId": 0,
  • "originStackRevStackId": 0,
  • "originStackRevName": "string",
  • "originStackRevNumber": 0,
  • "originStackRevVersion": "string",
  • "originStackRevCreatedAt": "2019-08-24T14:15:22Z",
  • "orgId": 0,
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get service

Returns the service identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "status": "string",
  • "external": true,
  • "public": true,
  • "revId": 0,
  • "draftRevId": 0,
  • "latestRevNumber": 0,
  • "gitRepoId": 0,
  • "gitRepoRemoteId": "string",
  • "gitRepoRef": "string",
  • "gitRepoRefType": "string",
  • "originStackRevId": 0,
  • "originStackRevStackId": 0,
  • "originStackRevName": "string",
  • "originStackRevNumber": 0,
  • "originStackRevVersion": "string",
  • "originStackRevCreatedAt": "2019-08-24T14:15:22Z",
  • "orgId": 0,
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update service settings

Updates service settings and returns the updated service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
object (GitAutoUpdateSettingsInput)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "status": "string",
  • "external": true,
  • "public": true,
  • "revId": 0,
  • "draftRevId": 0,
  • "latestRevNumber": 0,
  • "gitRepoId": 0,
  • "gitRepoRemoteId": "string",
  • "gitRepoRef": "string",
  • "gitRepoRefType": "string",
  • "originStackRevId": 0,
  • "originStackRevStackId": 0,
  • "originStackRevName": "string",
  • "originStackRevNumber": 0,
  • "originStackRevVersion": "string",
  • "originStackRevCreatedAt": "2019-08-24T14:15:22Z",
  • "orgId": 0,
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

List service link candidates

Returns service link candidates matching the request filters.

Authorizations:
apiKeyHeader
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
[
  • { }
]

Get service revision

Returns the service revision identified by the request path.

Authorizations:
apiKeyHeader
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

Stack catalog entries and stack revisions.

List stacks

Returns stacks matching the request filters.

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

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

Import stacks from Git

Starts a task that imports stacks from a Git repository.

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
remoteGitRepoId
required
string
gitRef
required
string
gitRefType
required
string
object (GitAutoUpdateSettingsInput)

Responses

Request samples

Content type
application/json
{
  • "orgId": 0,
  • "projectId": 0,
  • "integrationId": 0,
  • "remoteGitRepoId": "string",
  • "gitRef": "string",
  • "gitRefType": "string",
  • "autoUpdate": {
    }
}

Response samples

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

Validate stack manifest

Validates a Wodby stack manifest without creating a stack.

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
version
string

Optional revision version label for the generated non-Git resource.

manifestYaml
required
string

Complete Wodby service.yml or stack.yml manifest content.

object

Optional referenced file contents keyed by manifest-relative path, for example Dockerfile or configs/app.conf.

Responses

Request samples

Content type
application/json
{
  • "orgId": 0,
  • "projectId": 0,
  • "version": "string",
  • "manifestYaml": "string",
  • "files": {
    }
}

Response samples

Content type
application/json
{
  • "valid": true,
  • "error": "string",
  • "resource": { },
  • "manifest": { }
}

Create stack from manifest

Creates a non-Git Wodby stack from a stack manifest.

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
version
string

Optional revision version label for the generated non-Git resource.

manifestYaml
required
string

Complete Wodby service.yml or stack.yml manifest content.

object

Optional referenced file contents keyed by manifest-relative path, for example Dockerfile or configs/app.conf.

Responses

Request samples

Content type
application/json
{
  • "orgId": 0,
  • "projectId": 0,
  • "version": "string",
  • "manifestYaml": "string",
  • "files": {
    }
}

Response samples

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

Scaffold stack from Helm chart

Renders a Helm chart and returns best-effort Wodby service and stack manifests for review and validation.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
required
object (HelmChartInput)
serviceName
string

Optional generated Wodby service name.

serviceTitle
string

Optional generated Wodby service title.

serviceType
string

Optional generated Wodby service type. Defaults to service.

stackName
string

Optional generated Wodby stack name.

stackTitle
string

Optional generated Wodby stack title.

icon
string

Optional generated service and stack icon.

Responses

Request samples

Content type
application/json
{
  • "chart": {
    },
  • "serviceName": "string",
  • "serviceTitle": "string",
  • "serviceType": "string",
  • "stackName": "string",
  • "stackTitle": "string",
  • "icon": "string"
}

Response samples

Content type
application/json
{
  • "analysis": {
    },
  • "serviceManifestYaml": "string",
  • "serviceManifest": { },
  • "stackManifestYaml": "string",
  • "stackManifest": { },
  • "warnings": [
    ]
}

Get stack by name

Returns the stack identified by name.

Authorizations:
apiKeyHeader
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,
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get stack

Returns the stack identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
required
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,
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update stack settings

Updates stack settings and returns the updated stack.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
object (GitAutoUpdateSettingsInput)
object (StackAutoServiceRevisionUpdateSettingsInput)
object (StackAutoOriginUpdateSettingsInput)

Responses

Request samples

Content type
application/json
{
  • "gitAutoUpdate": {
    },
  • "autoServiceRevisionUpdate": {
    },
  • "autoOriginStackUpdate": {
    }
}

Response samples

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

Update stack from git

Starts a task that updates the stack from its configured Git source.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
gitRef
required
string
gitRefType
required
string

Responses

Request samples

Content type
application/json
{
  • "gitRef": "string",
  • "gitRefType": "string"
}

Response samples

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

Duplicate stack

Duplicates the stack into the target organization or project.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
orgId
integer

Optional for API-key requests; defaults to the API key's organization.

projectId
integer or null
object (CopyStackSettingsInput)

Responses

Request samples

Content type
application/json
{
  • "orgId": 0,
  • "projectId": 0,
  • "settings": {
    }
}

Response samples

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

Sync stack with origin

Syncs the stack with its origin stack revision.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
optional
deleteStackHelmValues
boolean or null
deleteStackEnvVars
boolean or null
deleteStackTokens
boolean or null
deleteStackAnnotations
boolean or null
deleteStackServices
boolean or null
deleteStackServicesConfiguration
boolean or null

Responses

Request samples

Content type
application/json
{
  • "deleteStackHelmValues": true,
  • "deleteStackEnvVars": true,
  • "deleteStackTokens": true,
  • "deleteStackAnnotations": true,
  • "deleteStackServices": true,
  • "deleteStackServicesConfiguration": true
}

Response samples

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

Publish stack draft

Publishes the current stack draft as the active stack revision.

Authorizations:
apiKeyHeader
path Parameters
id
required
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,
  • "settings": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get stack revision

Returns the stack revision identified by the request path.

Authorizations:
apiKeyHeader
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

Returns stack services matching the request filters.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

stack-services

Stack service definitions and stack-service actions.

List stack services

Returns stack services matching the request filters.

Authorizations:
apiKeyHeader
query Parameters
stackRevId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create stack service

Creates a stack service and returns the created resource.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
stackId
required
integer
serviceId
required
integer
name
required
string
title
required
string
required
required
boolean
replicas
required
integer
serviceRevPinned
boolean or null

Responses

Request samples

Content type
application/json
{
  • "stackId": 0,
  • "serviceId": 0,
  • "name": "string",
  • "title": "string",
  • "required": true,
  • "replicas": 0,
  • "serviceRevPinned": true
}

Response samples

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

Update stack service

Updates the stack service and returns the updated resource.

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

Responses

Request samples

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

Response samples

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

Delete stack service

Deletes the stack service and returns the operation result.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List stack service env vars

Returns environment variables configured for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create stack service env var

Creates an environment variable for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
workload
string or null
container
string or null
name
required
string
value
required
string
secret
required
boolean
envType
string or null

Responses

Request samples

Content type
application/json
{
  • "workload": "string",
  • "container": "string",
  • "name": "string",
  • "value": "string",
  • "secret": true,
  • "envType": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "stackServiceId": 0,
  • "workload": "string",
  • "container": "string",
  • "name": "string",
  • "value": "string",
  • "valueSecretId": 0,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Update stack service env var

Updates a stack service environment variable.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
value
required
string
secret
required
boolean

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "secret": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "stackServiceId": 0,
  • "workload": "string",
  • "container": "string",
  • "name": "string",
  • "value": "string",
  • "valueSecretId": 0,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete stack service env var

Deletes a stack service environment variable.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List stack service Helm values

Returns Helm values configured for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create stack service Helm value

Creates a Helm value override for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
name
required
string
value
required
string
secret
required
boolean
envType
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": "string",
  • "secret": true,
  • "envType": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "stackServiceId": 0,
  • "name": "string",
  • "value": "string",
  • "valueSecretId": 0,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Update stack service Helm value

Updates a stack service Helm value override.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
value
required
string
secret
required
boolean

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "secret": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "stackServiceId": 0,
  • "name": "string",
  • "value": "string",
  • "valueSecretId": 0,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete stack service Helm value

Deletes a stack service Helm value override.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List stack service tokens

Returns tokens configured for a stack service without revealing secret values.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create stack service token

Creates a token for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
name
required
string
value
string or null
secret
required
boolean
regex
string or null
envType
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": "string",
  • "secret": true,
  • "regex": "string",
  • "envType": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "stackServiceId": 0,
  • "name": "string",
  • "value": "string",
  • "regex": "string",
  • "valueSecretId": 0,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Update stack service token

Updates a stack service token value, secret flag, or regex.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
value
string or null
secret
required
boolean
regex
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "secret": true,
  • "regex": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "stackServiceId": 0,
  • "name": "string",
  • "value": "string",
  • "regex": "string",
  • "valueSecretId": 0,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete stack service token

Deletes a stack service token.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List stack service annotations

Returns annotations configured for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create stack service annotation

Creates an annotation for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
name
required
string
value
required
string
envType
string or null

Responses

Request samples

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

Response samples

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

Delete stack service annotation

Deletes a stack service annotation.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List stack service integrations

Returns integration links configured for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create stack service integration

Links an integration to a stack service integration slot.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
name
required
string
integrationId
required
integer

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "stackServiceId": 0,
  • "name": "string",
  • "integrationId": 0
}

Delete stack service integration

Removes an integration link from a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List stack service volumes

Returns volumes configured for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set stack service volume

Sets or clears a stack service volume size.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
name
required
string
Request Body schema: application/json
required
size
integer or null

Responses

Request samples

Content type
application/json
{
  • "size": 0
}

Response samples

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

Set stack service setting

Sets or clears a named setting value for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
name
required
string
Request Body schema: application/json
required
value
string or null

Responses

Request samples

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

Response samples

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

List stack service configs

Returns config overrides for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set stack service config

Sets a named config override for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
name
required
string
Request Body schema: application/json
required
config
required
string

Responses

Request samples

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

Response samples

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

Set stack service resources

Sets CPU and memory requests or limits for a stack service container.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
workload
string or null
container
string or null
requestCPU
integer or null
requestMem
integer or null
limitCPU
integer or null
limitMem
integer or null

Responses

Request samples

Content type
application/json
{
  • "workload": "string",
  • "container": "string",
  • "requestCPU": 0,
  • "requestMem": 0,
  • "limitCPU": 0,
  • "limitMem": 0
}

Response samples

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

Update stack service options

Replaces stack service option settings.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
required
Array of objects (StackServiceOptionInput)

Responses

Request samples

Content type
application/json
{
  • "options": [
    ]
}

Response samples

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

List stack service cron schedules

Returns cron schedules configured for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create stack service cron schedule

Creates a cron schedule for a stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
name
required
string
title
required
string
crontab
required
string
command
required
string
workload
string or null
disabled
boolean or null
envType
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "title": "string",
  • "crontab": "string",
  • "command": "string",
  • "workload": "string",
  • "disabled": true,
  • "envType": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "stackServiceId": 0,
  • "name": "string",
  • "title": "string",
  • "crontab": "string",
  • "command": "string",
  • "workload": "string",
  • "disabled": true,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update stack service cron schedule

Updates a stack service cron schedule.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
disabled
boolean or null
title
string or null
crontab
string or null
command
string or null
workload
string or null
envType
string or null

Responses

Request samples

Content type
application/json
{
  • "disabled": true,
  • "title": "string",
  • "crontab": "string",
  • "command": "string",
  • "workload": "string",
  • "envType": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "stackServiceId": 0,
  • "name": "string",
  • "title": "string",
  • "crontab": "string",
  • "command": "string",
  • "workload": "string",
  • "disabled": true,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete stack service cron schedule

Deletes a stack service cron schedule.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

backups

Backup records and backup creation.

List backups

Returns backups matching the request filters.

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create backup

Creates a backup and returns the created resource.

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

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

Returns the backup identified by the request path.

Authorizations:
apiKeyHeader
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

Import records and import creation.

List imports

Returns imports matching the request filters.

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create import

Creates an import and returns the created resource.

Authorizations:
apiKeyHeader
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

Returns the import identified by the request path.

Authorizations:
apiKeyHeader
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

User-visible task records and task actions.

List tasks

Returns tasks matching the request filters.

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

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

Get task

Returns the task identified by the request path.

Authorizations:
apiKeyHeader
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,
  • "user": {
    },
  • "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

Requests cancellation for the task.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

Repeat task

Creates a repeated run for the task.

Authorizations:
apiKeyHeader
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

Task step logs and log URLs.

Get task step logs

Returns current inline logs for pending task steps and a temporary log URL for persisted task steps.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
query Parameters
delivery
string
Default: "auto"
Enum: "auto" "inline" "url"

Delivery mode. Auto returns a URL for persisted logs and inline lines for pending or empty logs.

Responses

Response samples

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

Get task step log URL

Returns a temporary log URL for the task step.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

envs

Organization-level environment definitions.

List envs

Returns envs matching the request filters.

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

Content type
application/json
[
  • {
    }
]

Create env

Creates an env and returns the created resource.

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

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

Returns the env identified 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

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

Returns the env identified by the request path.

Authorizations:
apiKeyHeader
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

Updates the env and returns the updated resource.

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

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

Deletes the env and returns the operation result.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

Get OpenAPI YAML

Returns the public OpenAPI schema in YAML format.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 100,
  • "detail": "string",
  • "instance": "string",
  • "code": "string",
  • "message": "string",
  • "errors": [
    ]
}

Get OpenAPI JSON

Returns the public OpenAPI schema in JSON format.

Responses

Response samples

Content type
application/json
{ }