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",
  • "defaultTimeZone": "America/New_York",
  • "ciIntegrationId": 0,
  • "registryIntegrationId": 0,
  • "capabilities": {
    },
  • "subscription": {
    },
  • "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
defaultTimeZone
string
registryIntegrationId
integer or null

Omit or use null to preserve the current default, use 0 for the built-in registry, or use an organization-owned registry integration ID.

ciIntegrationId
integer or null

Omit or use null to preserve the current default, use 0 for the built-in CI service, or use an organization-owned CI integration ID.

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "defaultTimeZone": "America/New_York",
  • "registryIntegrationId": 0,
  • "ciIntegrationId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "domain": "string",
  • "defaultTimeZone": "America/New_York",
  • "ciIntegrationId": 0,
  • "registryIntegrationId": 0,
  • "capabilities": {
    },
  • "subscription": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Preflight app-service capacity

Evaluates whether the organization can add the requested number of enabled app services under the backend's effective billing policy.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
additionalUsage
required
integer >= 0

Number of enabled app services the operation would add.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "allowed": true,
  • "enforced": true,
  • "usage": 0.1,
  • "usageIncluded": 0.1,
  • "projectedUsage": 0.1
}

Get org subscription

Returns usage and pricing details for callers with billing-view access to the organization.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "plan": {
    }
}

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.

environmentName
required
string

Required for the canonical app environment contract.

environmentTitle
string

Defaults to environmentName when omitted.

environmentType
required
string
Enum: "prod" "test" "staging" "dev" "feature"

Required for the canonical app environment contract.

domain
string

Defaults to environmentName.name.orgDomain.

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
ciIntegrationId
integer or null

Omit or use null to inherit the organization default, use 0 for the built-in CI service, or use an accessible CI integration ID. A project-owned integration must be shared with the app's project.

registryIntegrationId
integer or null

Omit or use null to inherit the organization default, use 0 for the built-in registry, or use an accessible registry integration ID. A project-owned integration must be shared with the app's project.

deferInitialDeployment
boolean
Default: false

Defers the automatic initial build and deployment while preserving app environment initialization. Intended for automation that configures the environment before explicitly starting its first build.

object (AppEnvironmentSettingsInput)
object (NewAppEnvironmentAccessInput)

Responses

Request samples

Content type
application/json
{
  • "orgId": 0,
  • "name": "string",
  • "title": "string",
  • "environmentName": "string",
  • "environmentTitle": "string",
  • "environmentType": "prod",
  • "domain": "string",
  • "projectId": 0,
  • "stackRevId": 0,
  • "services": [
    ],
  • "clusterId": 0,
  • "ciIntegrationId": 0,
  • "registryIntegrationId": 0,
  • "deferInitialDeployment": false,
  • "settings": {
    },
  • "access": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "status": "string",
  • "clusterApp": true,
  • "orgId": 0,
  • "ownershipScope": "org",
  • "ownerProjectId": 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,
  • "ownershipScope": "org",
  • "ownerProjectId": 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,
  • "ownershipScope": "org",
  • "ownerProjectId": 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,
  • "ownershipScope": "org",
  • "ownerProjectId": 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-environments

Persistent, independently deployable application environments.

List app environments

Returns app environments 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 environment

Creates an app environment and returns the created resource.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
appId
required
integer
environmentName
required
string
environmentTitle
string

Defaults to environmentName when omitted.

environmentType
required
string
Enum: "prod" "test" "staging" "dev" "feature"
domain
string

Defaults to environmentName.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
ciIntegrationId
integer or null
registryIntegrationId
integer or null
deferInitialDeployment
boolean
Default: false
object (AppEnvironmentSettingsInput)
object (NewAppEnvironmentAccessInput)

Responses

Request samples

Content type
application/json
{
  • "appId": 0,
  • "environmentName": "string",
  • "environmentTitle": "string",
  • "environmentType": "prod",
  • "domain": "string",
  • "stackRevId": 0,
  • "services": [
    ],
  • "clusterId": 0,
  • "ciIntegrationId": 0,
  • "registryIntegrationId": 0,
  • "deferInitialDeployment": false,
  • "settings": {
    },
  • "access": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "environmentType": "prod",
  • "status": "string",
  • "outdated": true,
  • "mainDomain": "string",
  • "mainRouteCert": {
    },
  • "appId": 0,
  • "clusterId": 0,
  • "stackId": 0,
  • "stackRevId": 0,
  • "stackName": "string",
  • "stackTitle": "string",
  • "stackIcon": "string",
  • "stackRevNumber": 0,
  • "stackVersion": "string",
  • "access": {
    },
  • "routingMode": "string",
  • "routingPending": true,
  • "maintenanceMode": true,
  • "maintenanceModeActive": true,
  • "configurationReady": true,
  • "configurationIssues": [
    ],
  • "settings": {
    },
  • "health": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get app environment by name

Returns the app environment identified by app and environment name.

Authorizations:
apiKeyHeader
path Parameters
appName
required
string
environmentName
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",
  • "environmentType": "prod",
  • "status": "string",
  • "outdated": true,
  • "mainDomain": "string",
  • "mainRouteCert": {
    },
  • "appId": 0,
  • "clusterId": 0,
  • "stackId": 0,
  • "stackRevId": 0,
  • "stackName": "string",
  • "stackTitle": "string",
  • "stackIcon": "string",
  • "stackRevNumber": 0,
  • "stackVersion": "string",
  • "access": {
    },
  • "routingMode": "string",
  • "routingPending": true,
  • "maintenanceMode": true,
  • "maintenanceModeActive": true,
  • "configurationReady": true,
  • "configurationIssues": [
    ],
  • "settings": {
    },
  • "health": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get app environment

Returns the app environment 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",
  • "environmentType": "prod",
  • "status": "string",
  • "outdated": true,
  • "mainDomain": "string",
  • "mainRouteCert": {
    },
  • "appId": 0,
  • "clusterId": 0,
  • "stackId": 0,
  • "stackRevId": 0,
  • "stackName": "string",
  • "stackTitle": "string",
  • "stackIcon": "string",
  • "stackRevNumber": 0,
  • "stackVersion": "string",
  • "access": {
    },
  • "routingMode": "string",
  • "routingPending": true,
  • "maintenanceMode": true,
  • "maintenanceModeActive": true,
  • "configurationReady": true,
  • "configurationIssues": [
    ],
  • "settings": {
    },
  • "health": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update app environment

Updates the app environment 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",
  • "environmentType": "prod",
  • "status": "string",
  • "outdated": true,
  • "mainDomain": "string",
  • "mainRouteCert": {
    },
  • "appId": 0,
  • "clusterId": 0,
  • "stackId": 0,
  • "stackRevId": 0,
  • "stackName": "string",
  • "stackTitle": "string",
  • "stackIcon": "string",
  • "stackRevNumber": 0,
  • "stackVersion": "string",
  • "access": {
    },
  • "routingMode": "string",
  • "routingPending": true,
  • "maintenanceMode": true,
  • "maintenanceModeActive": true,
  • "configurationReady": true,
  • "configurationIssues": [
    ],
  • "settings": {
    },
  • "health": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete app environment

Deletes the app environment 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 environment settings

Updates app environment settings and returns the updated app environment.

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "environmentType": "prod",
  • "status": "string",
  • "outdated": true,
  • "mainDomain": "string",
  • "mainRouteCert": {
    },
  • "appId": 0,
  • "clusterId": 0,
  • "stackId": 0,
  • "stackRevId": 0,
  • "stackName": "string",
  • "stackTitle": "string",
  • "stackIcon": "string",
  • "stackRevNumber": 0,
  • "stackVersion": "string",
  • "access": {
    },
  • "routingMode": "string",
  • "routingPending": true,
  • "maintenanceMode": true,
  • "maintenanceModeActive": true,
  • "configurationReady": true,
  • "configurationIssues": [
    ],
  • "settings": {
    },
  • "health": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update app environment maintenance mode

Enables or disables the fixed maintenance response on all public HTTP routes while application workloads continue running.

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

Responses

Request samples

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

Response samples

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

Get app environment CI/CD settings

Returns the CI and registry integrations used by future app environment builds. Integration ID 0 identifies the built-in Wodby service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "appEnvironmentId": 0,
  • "ciIntegrationId": 0,
  • "registryIntegrationId": 0,
  • "registryRepository": "string"
}

Update app environment CI/CD settings

Updates the CI and registry integrations used by future app environment builds. Integration ID 0 selects the built-in Wodby service.

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

CI integration ID. Set to zero to use the built-in Wodby CI service.

registryIntegrationId
required
integer

Registry integration ID. Set to zero to use the built-in Wodby registry service.

Responses

Request samples

Content type
application/json
{
  • "ciIntegrationId": 0,
  • "registryIntegrationId": 0
}

Response samples

Content type
application/json
{
  • "appEnvironmentId": 0,
  • "ciIntegrationId": 0,
  • "registryIntegrationId": 0,
  • "registryRepository": "string"
}

Upgrade app environment stack

Upgrades an app environment stack using the selected upgrade sections.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
deployment
boolean
Default: true

Build affected services when required and deploy the upgraded stack configuration.

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
{
  • "deployment": true,
  • "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
}

Reconcile app environment stack

Reapplies the app environment's assigned stack revision using the selected override sections without changing its stack revision.

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
}

Preview app environment stack upgrade

Returns the stack and service revision changes that an app environment stack upgrade would apply.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "previousStackVersion": "string",
  • "stackVersion": "string",
  • "previousStackRevNumber": 0,
  • "stackRevNumber": 0,
  • "serviceChanges": [
    ]
}

Get app environment access

Returns the external access configuration for the app environment identified by the path.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mode": "protected",
  • "scope": "entire_app",
  • "status": "string",
  • "settings": [
    ],
  • "publicRoutesSuppressed": true,
  • "effectiveUrl": "string",
  • "lastError": "string",
  • "integrationId": 0,
  • "endpoints": [
    ],
  • "resources": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create app environment access

Creates external access for the app environment identified by the path. An active paid subscription is required.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
integrationId
required
integer
mode
required
string
Enum: "PROTECTED" "PRIVATE_NETWORK"
scope
required
string
Enum: "ENTIRE_APP" "SELECTED_ENDPOINTS"
Array of objects (AppAccessSettingInput)
required
Array of objects (AppAccessEndpointInput)

Responses

Request samples

Content type
application/json
{
  • "integrationId": 0,
  • "mode": "PROTECTED",
  • "scope": "ENTIRE_APP",
  • "settings": [
    ],
  • "endpoints": [
    ]
}

Response samples

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

Preflight app environment access

Validates a proposed app-access configuration before an app environment or access resource is created. An active paid subscription is required.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
integrationId
required
integer
mode
required
string
Enum: "PROTECTED" "PRIVATE_NETWORK"
scope
required
string
Enum: "ENTIRE_APP" "SELECTED_ENDPOINTS"
Array of objects (AppAccessSettingInput)
host
string or null

Required only when the selected provider uses a customer-assigned hostname.

Array of objects (NewAppEnvironmentAccessEndpointInput)

HTTP endpoints selected during creation. Used only with SELECTED_ENDPOINTS scope; older clients may omit it to select the main endpoint.

Responses

Request samples

Content type
application/json
{
  • "integrationId": 0,
  • "mode": "PROTECTED",
  • "scope": "ENTIRE_APP",
  • "settings": [
    ],
  • "host": "string",
  • "endpoints": [
    ]
}

Response samples

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

Update app access

Updates an existing app-access configuration and starts its reconciliation task. An active paid subscription is required.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
scope
required
string
Enum: "ENTIRE_APP" "SELECTED_ENDPOINTS"
Array of objects (AppAccessSettingInput)
required
Array of objects (AppAccessEndpointInput)

Responses

Request samples

Content type
application/json
{
  • "scope": "ENTIRE_APP",
  • "settings": [
    ],
  • "endpoints": [
    ]
}

Response samples

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

Delete app access

Removes app access and returns the cleanup task identifier.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List app-access cleanups

Returns cleanup records for exactly one app instance or integration.

Authorizations:
apiKeyHeader
query Parameters
appInstanceId
integer
integrationId
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retry app-access cleanup

Retries a failed app-access cleanup and returns its task identifier.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

app-auths

HTTP basic authentication credentials scoped to app environments, services, or routes.

List app auths

Returns HTTP basic authentication entries for an app environment without exposing passwords or secret identifiers.

Authorizations:
apiKeyHeader
query Parameters
appInstanceId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create app auth

Creates an HTTP basic authentication entry at instance, service, or route scope and returns only non-secret metadata.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
appInstanceId
required
integer
appServiceIds
Array of integers or null

App services to protect. Omit or pass an empty list to protect the whole app environment.

appServiceId
integer or null
Deprecated

Single-service scope. Ignored when appServiceIds is supplied.

appRouteId
integer or null

Route scope. The owning app service is derived from the route.

login
required
string
password
required
string <password>
realm
required
string

Responses

Request samples

Content type
application/json
{
  • "appInstanceId": 0,
  • "appServiceIds": [
    ],
  • "appServiceId": 0,
  • "appRouteId": 0,
  • "login": "string",
  • "password": "pa$$word",
  • "realm": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "appInstanceId": 0,
  • "scope": "APP",
  • "appServiceIds": [
    ],
  • "appServiceId": 0,
  • "appRouteId": 0,
  • "login": "string",
  • "realm": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update app auth

Updates an HTTP basic authentication entry. Omit both scope identifiers to preserve the current scope. Supplying appServiceId moves the entry to service scope and clears any route unless appRouteId is also supplied. Recreate the entry to move it back to instance scope. Omit password to retain the existing secret.

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

App services to protect. Omit every scope field to preserve the current scope, or pass an empty list to protect the whole app environment.

appServiceId
integer or null
Deprecated

Single-service scope. Ignored when appServiceIds is supplied.

appRouteId
integer or null

Moves the entry to route scope. The owning app service is derived from the route.

login
required
string
password
string or null <password>

Replaces the existing secret when supplied; omit to keep the current password.

realm
required
string

Responses

Request samples

Content type
application/json
{
  • "appServiceIds": [
    ],
  • "appServiceId": 0,
  • "appRouteId": 0,
  • "login": "string",
  • "password": "pa$$word",
  • "realm": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "appInstanceId": 0,
  • "scope": "APP",
  • "appServiceIds": [
    ],
  • "appServiceId": 0,
  • "appRouteId": 0,
  • "login": "string",
  • "realm": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete app auth

Deletes an HTTP basic authentication entry and returns the operation result.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

app-services

Runtime services that belong to app environments.

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,
  • "scalability": {
    },
  • "version": "string",
  • "main": true,
  • "disabled": true,
  • "external": true,
  • "required": true,
  • "needsRebuild": true,
  • "needsRedeploy": true,
  • "stackState": "current",
  • "configurationReady": true,
  • "buildSourceBoilerplate": "string",
  • "ciPolicy": "INHERIT",
  • "effectiveCiIntegrationId": 0,
  • "configurationIssues": [
    ],
  • "appInstanceId": 0,
  • "serviceRevId": 0,
  • "parentAppServiceId": 0,
  • "deploymentConfiguration": {
    },
  • "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
object (AppServiceScalabilityUpdateInput)
version
string or null
disabled
boolean or null
main
boolean or null
object (BuildSourceInput)
object (ServiceDeploymentConfigurationInput)

Replaces the complete service-level deployment override. An empty object clears it.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "status": "string",
  • "replicas": 0,
  • "scalability": {
    },
  • "version": "string",
  • "main": true,
  • "disabled": true,
  • "external": true,
  • "required": true,
  • "needsRebuild": true,
  • "needsRedeploy": true,
  • "stackState": "current",
  • "configurationReady": true,
  • "buildSourceBoilerplate": "string",
  • "ciPolicy": "INHERIT",
  • "effectiveCiIntegrationId": 0,
  • "configurationIssues": [
    ],
  • "appInstanceId": 0,
  • "serviceRevId": 0,
  • "parentAppServiceId": 0,
  • "deploymentConfiguration": {
    },
  • "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 across all replicas or for one selected pod and returns the stream id. Log streams are available while the app environment status is ok or deploying.

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

Responses

Request samples

Content type
application/json
{
  • "workload": "string",
  • "container": "string",
  • "pod": "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 non-empty
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 non-empty
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",
  • "secret": true,
  • "hasValue": true,
  • "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
[
  • {
    }
]

List app service volumes

Returns configured volume metadata together with effective Kubernetes storage-class state.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add an optional app service volume

Adds a volume that is optional in the service manifest and returns the reconciliation task identifier.

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

Responses

Request samples

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

Response samples

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

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,
  • "scalability": {
    },
  • "version": "string",
  • "main": true,
  • "disabled": true,
  • "external": true,
  • "required": true,
  • "needsRebuild": true,
  • "needsRedeploy": true,
  • "stackState": "current",
  • "configurationReady": true,
  • "buildSourceBoilerplate": "string",
  • "ciPolicy": "INHERIT",
  • "effectiveCiIntegrationId": 0,
  • "configurationIssues": [
    ],
  • "appInstanceId": 0,
  • "serviceRevId": 0,
  • "parentAppServiceId": 0,
  • "deploymentConfiguration": {
    },
  • "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
name
string or null

Stable cron schedule identity. When omitted or blank, the server generates a unique name.

title
required
string
crontab
required
string
command
required
string
workload
string or null
disabled
boolean or null

Creates the schedule disabled. Disabled schedules do not require cron feature access.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "appServiceId": 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 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,
  • "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 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",
  • "compactTitle": "string",
  • "executionScope": "user",
  • "status": "string",
  • "progress": 0,
  • "silent": true,
  • "system": true,
  • "userId": 0,
  • "user": {
    },
  • "orgId": 0,
  • "projectIds": [
    ],
  • "appId": 0,
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "clusterId": 0,
  • "databaseId": 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
}

List app service volume storage-class state

Returns configured and effective storage-class choices for each app service volume.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List effective backup option defaults

Returns the effective default option values for an app service backup definition.

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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",
  • "postDeploymentStatus": "unknown",
  • "skipRollback": true,
  • "canCancel": true,
  • "appInstanceId": 0,
  • "builds": [
    ],
  • "preparationTaskId": 0,
  • "preparationTask": {
    },
  • "taskId": 0,
  • "task": {
    },
  • "postDeploymentTaskId": 0,
  • "postDeploymentTask": {
    },
  • "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",
  • "postDeploymentStatus": "unknown",
  • "skipRollback": true,
  • "canCancel": true,
  • "appInstanceId": 0,
  • "builds": [
    ],
  • "preparationTaskId": 0,
  • "preparationTask": {
    },
  • "taskId": 0,
  • "task": {
    },
  • "postDeploymentTaskId": 0,
  • "postDeploymentTask": {
    },
  • "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",
  • "postDeploymentStatus": "unknown",
  • "skipRollback": true,
  • "canCancel": true,
  • "appInstanceId": 0,
  • "builds": [
    ],
  • "preparationTaskId": 0,
  • "preparationTask": {
    },
  • "taskId": 0,
  • "task": {
    },
  • "postDeploymentTaskId": 0,
  • "postDeploymentTask": {
    },
  • "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",
  • "postDeploymentStatus": "unknown",
  • "skipRollback": true,
  • "canCancel": true,
  • "appInstanceId": 0,
  • "builds": [
    ],
  • "preparationTaskId": 0,
  • "preparationTask": {
    },
  • "taskId": 0,
  • "task": {
    },
  • "postDeploymentTaskId": 0,
  • "postDeploymentTask": {
    },
  • "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"
}

Cancel deployment

Cancels an active deployment and returns its updated state.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "status": "string",
  • "rollbackStatus": "not_attempted",
  • "postDeploymentStatus": "unknown",
  • "skipRollback": true,
  • "canCancel": true,
  • "appInstanceId": 0,
  • "builds": [
    ],
  • "preparationTaskId": 0,
  • "preparationTask": {
    },
  • "taskId": 0,
  • "task": {
    },
  • "postDeploymentTaskId": 0,
  • "postDeploymentTask": {
    },
  • "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 build source owner and image targets linked to that owner. Services with independent build sources are omitted.

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",
  • "postDeploymentStatus": "unknown",
  • "skipRollback": true,
  • "canCancel": true,
  • "appInstanceId": 0,
  • "builds": [
    ],
  • "preparationTaskId": 0,
  • "preparationTask": {
    },
  • "taskId": 0,
  • "task": {
    },
  • "postDeploymentTaskId": 0,
  • "postDeploymentTask": {
    },
  • "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 environments.

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
disabled
boolean or null

Creates the custom domain disabled. Disabled domains do not require custom-domain feature access until enabled.

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: "SERVE" "BACKEND" "REDIRECT"

SERVE sends requests to the selected app service. BACKEND is accepted for backwards compatibility.

redirectScheme
string or null
redirectHost
string or null
redirectPath
string or null
redirectStatusCode
integer or null
hsts
boolean or null

Enables HTTP Strict Transport Security for a serve route when TLS is active.

letsencrypt
boolean or null
object (AppRouteTLSInput)

Responses

Request samples

Content type
application/json
{
  • "appServiceId": 0,
  • "disabled": true,
  • "main": true,
  • "primary": true,
  • "port": 0,
  • "host": "string",
  • "path": "string",
  • "pathType": "PREFIX",
  • "action": "SERVE",
  • "redirectScheme": "string",
  • "redirectHost": "string",
  • "redirectPath": "string",
  • "redirectStatusCode": 0,
  • "hsts": true,
  • "letsencrypt": true,
  • "tls": {
    }
}

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",
  • "attachmentStatus": "UNKNOWN",
  • "attachmentCheckedAt": "2019-08-24T14:15:22Z",
  • "attachmentError": "string",
  • "disabled": true,
  • "main": true,
  • "primary": true,
  • "private": true,
  • "technical": 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",
  • "attachmentStatus": "UNKNOWN",
  • "attachmentCheckedAt": "2019-08-24T14:15:22Z",
  • "attachmentError": "string",
  • "disabled": true,
  • "main": true,
  • "primary": true,
  • "private": true,
  • "technical": 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
appServiceId
integer or null

Target app service for retargeting. Must be supplied together with port.

port
integer or null

Target public HTTP port for retargeting. Must be supplied together with appServiceId.

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: "SERVE" "BACKEND" "REDIRECT"

SERVE sends requests to the selected app service. BACKEND is accepted for backwards compatibility.

redirectScheme
string or null
redirectHost
string or null
redirectPath
string or null
redirectStatusCode
integer or null
object (AppRouteTLSInput)

Responses

Request samples

Content type
application/json
{
  • "appServiceId": 0,
  • "port": 0,
  • "disabled": true,
  • "main": true,
  • "primary": true,
  • "path": "string",
  • "pathType": "PREFIX",
  • "action": "SERVE",
  • "redirectScheme": "string",
  • "redirectHost": "string",
  • "redirectPath": "string",
  • "redirectStatusCode": 0,
  • "tls": {
    }
}

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",
  • "attachmentStatus": "UNKNOWN",
  • "attachmentCheckedAt": "2019-08-24T14:15:22Z",
  • "attachmentError": "string",
  • "disabled": true,
  • "main": true,
  • "primary": true,
  • "private": true,
  • "technical": 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 a customer route and returns the operation result. Wodby-managed technical routes cannot be deleted; disable them instead.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List app route settings

Returns route-specific setting overrides. Inherited app-environment defaults are not included.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List effective app route settings

Returns the resolved route settings together with whether each value came from the app defaults, active service manifest, or route override.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retry app route certificate

Starts certificate reconciliation again for a route whose managed certificate issuance failed or stalled.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

Set app route setting

Creates or updates a named app route setting.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
name
required
string (AppRouteSettingName)
Enum: "HTTPS_REDIRECT" "NO_INDEX" "REQUEST_BODY_SIZE" "SESSION_AFFINITY" "PATH_REWRITE" "HSTS" "REQUEST_TIMEOUT" "BACKEND_REQUEST_TIMEOUT"
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,
  • "appInstanceId": 0,
  • "routeId": 0,
  • "default": true,
  • "name": "HTTPS_REDIRECT",
  • "value": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete app route setting

Deletes a named app route setting and restores any applicable default.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
name
required
string (AppRouteSettingName)
Enum: "HTTPS_REDIRECT" "NO_INDEX" "REQUEST_BODY_SIZE" "SESSION_AFFINITY" "PATH_REWRITE" "HSTS" "REQUEST_TIMEOUT" "BACKEND_REQUEST_TIMEOUT"

Responses

Response samples

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

certs

TLS certificate metadata for routes, app services, app environments, 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.

host
string

When supplied, returns only usable custom certificates whose DNS names cover this host.

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,
  • "custom": true,
  • "issuer": "string",
  • "domain": "string",
  • "dnsNames": [
    ],
  • "routeIds": [
    ],
  • "fingerprint": "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"
}

Delete custom certificate

Deletes an uploaded certificate that is not attached to any route or other resource.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

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
environmentId
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
autoInfrastructureUpgrade
boolean or null
object (ClusterEnvironmentPolicyInput)

Use envType and allowedEnvTypes. Legacy ID fields remain accepted but cannot be mixed with their type equivalents.

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,
  • "autoInfrastructureUpgrade": true,
  • "environmentPolicy": {
    }
}

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,
  • "envId": 0,
  • "envType": "prod",
  • "envScope": "all",
  • "allowedEnvIds": [
    ],
  • "allowedEnvTypes": [
    ],
  • "orgId": 0,
  • "ownershipScope": "org",
  • "ownerProjectId": 0,
  • "capabilities": {
    },
  • "settings": {
    },
  • "storageClasses": [
    ],
  • "storageClassesObservedAt": "2019-08-24T14:15:22Z",
  • "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,
  • "envId": 0,
  • "envType": "prod",
  • "envScope": "all",
  • "allowedEnvIds": [
    ],
  • "allowedEnvTypes": [
    ],
  • "orgId": 0,
  • "ownershipScope": "org",
  • "ownerProjectId": 0,
  • "capabilities": {
    },
  • "settings": {
    },
  • "storageClasses": [
    ],
  • "storageClassesObservedAt": "2019-08-24T14:15:22Z",
  • "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,
  • "envId": 0,
  • "envType": "prod",
  • "envScope": "all",
  • "allowedEnvIds": [
    ],
  • "allowedEnvTypes": [
    ],
  • "orgId": 0,
  • "ownershipScope": "org",
  • "ownerProjectId": 0,
  • "capabilities": {
    },
  • "settings": {
    },
  • "storageClasses": [
    ],
  • "storageClassesObservedAt": "2019-08-24T14:15:22Z",
  • "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,
  • "envId": 0,
  • "envType": "prod",
  • "envScope": "all",
  • "allowedEnvIds": [
    ],
  • "allowedEnvTypes": [
    ],
  • "orgId": 0,
  • "ownershipScope": "org",
  • "ownerProjectId": 0,
  • "capabilities": {
    },
  • "settings": {
    },
  • "storageClasses": [
    ],
  • "storageClassesObservedAt": "2019-08-24T14:15:22Z",
  • "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
}

Get Kubernetes version upgrade plan

Returns supported Kubernetes upgrade targets, blockers, and warnings for a cluster.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "currentVersion": "string",
  • "providerVersion": "string",
  • "provider": "string",
  • "supported": true,
  • "targets": [
    ],
  • "blockers": [
    ],
  • "warnings": [
    ],
  • "observedAt": "2019-08-24T14:15:22Z"
}

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,
  • "envId": 0,
  • "envType": "prod",
  • "envScope": "all",
  • "allowedEnvIds": [
    ],
  • "allowedEnvTypes": [
    ],
  • "orgId": 0,
  • "ownershipScope": "org",
  • "ownerProjectId": 0,
  • "capabilities": {
    },
  • "settings": {
    },
  • "storageClasses": [
    ],
  • "storageClassesObservedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update cluster environment policy

Updates the cluster's environment type and allowed environment-type scope. Scope reductions that conflict with existing non-infrastructure app environments are rejected.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
envId
integer
Deprecated
envType
string
Enum: "prod" "test" "staging" "dev" "feature"
scope
required
string
Enum: "all" "selected"
allowedEnvIds
Array of integers
Deprecated
allowedEnvTypes
Array of strings
Items Enum: "prod" "test" "staging" "dev" "feature"

Responses

Request samples

Content type
application/json
{
  • "envId": 0,
  • "envType": "prod",
  • "scope": "all",
  • "allowedEnvIds": [
    ],
  • "allowedEnvTypes": [
    ]
}

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,
  • "envId": 0,
  • "envType": "prod",
  • "envScope": "all",
  • "allowedEnvIds": [
    ],
  • "allowedEnvTypes": [
    ],
  • "orgId": 0,
  • "ownershipScope": "org",
  • "ownerProjectId": 0,
  • "capabilities": {
    },
  • "settings": {
    },
  • "storageClasses": [
    ],
  • "storageClassesObservedAt": "2019-08-24T14:15:22Z",
  • "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
}

Preview cluster infrastructure app upgrades

Returns stack and service revision changes for infrastructure apps on the cluster.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
query Parameters
appInstanceId
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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
integer
Deprecated
envType
string
Enum: "prod" "test" "staging" "dev" "feature"
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,
  • "envType": "prod",
  • "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,
  • "envType": "prod",
  • "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,
  • "envType": "prod",
  • "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,
  • "envType": "prod",
  • "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,
  • "envType": "prod",
  • "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

envId
integer >= 1
Deprecated

Legacy environment entity filter. Use envType.

envType
string
Enum: "prod" "test" "staging" "dev" "feature"

Return only integrations allowed for this fixed environment type.

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
title
required
string
kinds
required
Array of strings
auth
string or null
projectId
integer or null
Array of objects (FieldInput)
scope
string or null
object (IntegrationEnvironmentPolicyInput)

Use primaryEnvType and allowedEnvTypes. Legacy ID fields remain accepted but cannot be mixed with their type equivalents.

Responses

Request samples

Content type
application/json
{
  • "orgId": 0,
  • "providerId": 0,
  • "title": "string",
  • "kinds": [
    ],
  • "auth": "string",
  • "projectId": 0,
  • "fieldsInput": [
    ],
  • "scope": "string",
  • "environmentPolicy": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "status": "string",
  • "scope": "string",
  • "auth": "string",
  • "outdated": true,
  • "providerRevId": 0,
  • "orgId": 0,
  • "primaryEnvId": 0,
  • "primaryEnvType": "prod",
  • "envScope": "all",
  • "allowedEnvIds": [
    ],
  • "allowedEnvTypes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Resolve or create integration

Reuses an accessible integration when provider, kinds, scope, environment scopes, and credential values match exactly; otherwise creates it.

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
title
required
string
kinds
required
Array of strings
auth
string or null
projectId
integer or null
Array of objects (FieldInput)
scope
string or null
object (IntegrationEnvironmentPolicyInput)

Use primaryEnvType and allowedEnvTypes. Legacy ID fields remain accepted but cannot be mixed with their type equivalents.

Responses

Request samples

Content type
application/json
{
  • "orgId": 0,
  • "providerId": 0,
  • "title": "string",
  • "kinds": [
    ],
  • "auth": "string",
  • "projectId": 0,
  • "fieldsInput": [
    ],
  • "scope": "string",
  • "environmentPolicy": {
    }
}

Response samples

Content type
application/json
{
  • "integration": {
    },
  • "created": true
}

Search integrations

Returns accessible integrations matching structured type, status, label, variable, project, and environment requirements.

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

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

projectIds
Array of integers
types
Array of strings
Items Enum: "GIT" "STORAGE" "KUBERNETES" "DB" "VARIABLE" "REGISTRY" "NFS" "CI" "SMTP" "APPLICATION_ACCESS" "VPN"
statuses
Array of strings
Items Enum: "OK" "CREATING" "DELETING" "DELETED" "DISABLED" "DEPRECATED" "EOL" "ABANDONED" "ERRORED" "UPDATING" "EXPIRED"
labels
Array of strings
Array of objects (IntegrationVariableRequirementInput)
envId
integer or null >= 1
Deprecated
envType
string or null
Enum: "prod" "test" "staging" "dev" "feature"

Responses

Request samples

Content type
application/json
{
  • "orgId": 0,
  • "projectIds": [
    ],
  • "types": [
    ],
  • "statuses": [
    ],
  • "labels": [
    ],
  • "variables": [
    ],
  • "envId": 1,
  • "envType": "prod"
}

Response samples

Content type
application/json
[
  • {
    }
]

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
[
  • {
    }
]

Check a remote Git repository file

Returns whether a file exists at an exact repository ref through the selected Git integration.

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

Responses

Response samples

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

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,
  • "title": "string",
  • "status": "string",
  • "scope": "string",
  • "auth": "string",
  • "outdated": true,
  • "providerRevId": 0,
  • "orgId": 0,
  • "primaryEnvId": 0,
  • "primaryEnvType": "prod",
  • "envScope": "all",
  • "allowedEnvIds": [
    ],
  • "allowedEnvTypes": [
    ],
  • "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
kinds
required
Array of strings
scope
string or null
Array of objects (FieldInput)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "status": "string",
  • "scope": "string",
  • "auth": "string",
  • "outdated": true,
  • "providerRevId": 0,
  • "orgId": 0,
  • "primaryEnvId": 0,
  • "primaryEnvType": "prod",
  • "envScope": "all",
  • "allowedEnvIds": [
    ],
  • "allowedEnvTypes": [
    ],
  • "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
}

Preview provider revision upgrade

Returns the compatibility decision and revision details for upgrading an integration.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "state": "current",
  • "reasons": [
    ],
  • "removedFields": [
    ],
  • "canDropRemovedFields": true,
  • "currentRevision": {
    },
  • "targetRevision": {
    }
}

Update integration environment policy

Updates the associated environment and exact allowed environment scope. Scope reductions that conflict with existing references are rejected.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
primaryEnvId
integer or null
Deprecated
primaryEnvType
string or null
Enum: "prod" "test" "staging" "dev" "feature"
scope
required
string
Enum: "all" "selected"
allowedEnvIds
Array of integers
Deprecated
allowedEnvTypes
Array of strings
Items Enum: "prod" "test" "staging" "dev" "feature"

Responses

Request samples

Content type
application/json
{
  • "primaryEnvId": 0,
  • "primaryEnvType": "prod",
  • "scope": "all",
  • "allowedEnvIds": [
    ],
  • "allowedEnvTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "status": "string",
  • "scope": "string",
  • "auth": "string",
  • "outdated": true,
  • "providerRevId": 0,
  • "orgId": 0,
  • "primaryEnvId": 0,
  • "primaryEnvType": "prod",
  • "envScope": "all",
  • "allowedEnvIds": [
    ],
  • "allowedEnvTypes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Configure integration

Atomically updates integration metadata, adds selected kinds, merges field values, and returns any background activation or permission-test task.

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

Responses

Request samples

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

Response samples

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

Get app-access provider options

Returns supported app-access modes, scopes, fields, and hostname behavior for the integration.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "provider": "string",
  • "modes": [
    ],
  • "scopes": [
    ],
  • "endpointHostMode": "string",
  • "fields": [
    ],
  • "configurations": [
    ]
}

Validate an app-access hostname

Validates an app-access hostname against the provider settings of the integration.

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

Responses

Request samples

Content type
application/json
{
  • "settings": [
    ],
  • "host": "string"
}

Response samples

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

Test integration permissions

Starts the provider permission audit configured by the integration's provider revision.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

Upgrade integration provider revision

Upgrades an integration to its eligible provider revision and optionally drops fields removed by the target contract.

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

Permanently deletes fields absent from the target revision when the preview allows it.

Responses

Request samples

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

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
}

Create variable provider

Creates a private provider whose integration fields are exposed as service environment variables.

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
name
required
string
title
required
string
required
Array of objects (NewVariableProviderFieldInput) non-empty

Responses

Request samples

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

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

Create provider from manifest

Creates a namespaced, versioned variable provider from manifest YAML.

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
manifestYaml
required
string

Complete variable provider manifest YAML.

Responses

Request samples

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

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

Import providers from Git

Starts a task that imports provider.yml or all providers listed by index.yml 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
}

Update provider from Git

Starts an update from the selected ref. Changing a shared repository ref updates all repository usages.

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
}

Update provider from manifest

Starts an update of a non-Git provider from versioned manifest YAML.

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

Complete versioned variable provider manifest YAML.

Responses

Request samples

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

Response samples

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

Update provider settings

Updates Git auto-update settings shared by the repository usages.

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

Responses

Request samples

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

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 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",
  • "icon": "string",
  • "title": "string",
  • "number": 0,
  • "version": "string",
  • "providerId": 0,
  • "manifest": { },
  • "permissionAudit": true,
  • "createdAt": "2019-08-24T14:15:22Z"
}

git-repos

Shared Git repository usages and repository-wide update actions.

Get Git repository usages

Returns every service, stack, and provider that shares the Git repository.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "services": [
    ],
  • "stacks": [
    ],
  • "providers": [
    ]
}

Update all Git repository usages

Starts one parent task that updates every service, stack, and provider sharing the selected repository to the requested ref.

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
}

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)
registryIntegrationId
integer or null

Optional registry integration used when an imported service image requires authentication.

Responses

Request samples

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

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

Update service from manifest

Updates an existing non-Git Wodby service from a service manifest and starts a service update task.

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

Optional service revision version; defaults to the current service version.

manifestYaml
required
string

Complete Wodby service.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
{
  • "version": "string",
  • "manifestYaml": "string",
  • "files": {
    }
}

Response samples

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

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)
object (ServiceAutoBaseRevisionUpdateSettingsInput)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "status": "string",
  • "external": true,
  • "public": true,
  • "revId": 0,
  • "latestRevNumber": 0,
  • "orgId": 0,
  • "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
}

List public catalog stacks

Returns public stacks that can be duplicated into an organization or project.

Authorizations:
apiKeyHeader

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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",
  • "outdated": 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 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",
  • "outdated": 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 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",
  • "outdated": 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"
}

Rename stack

Updates the name and title of the stack identified by the request path.

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

Unique stack machine name within the organization.

title
required
string non-empty

Human-readable stack title.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "icon": "string",
  • "status": "string",
  • "outdated": 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"
}

Delete stack

Deletes an unused stack and returns the operation result.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

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",
  • "outdated": 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 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
sourceRevId
integer or null

Optional immutable source stack revision to duplicate. It must belong to the stack in the request path.

object (CopyStackSettingsInput)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "icon": "string",
  • "status": "string",
  • "outdated": 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"
}

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",
  • "outdated": 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"
}

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",
  • "outdated": 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 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",
  • "linkIssues": [
    ],
  • "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
[
  • {
    }
]

List stack env vars

Returns stack-wide environment variables for a stack revision.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create stack env var

Creates a stack-wide environment variable.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
name
required
string
value
required
string non-empty
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,
  • "name": "string",
  • "value": "string",
  • "valueSecretId": 0,
  • "envType": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Update stack env var

Updates a stack-wide environment variable.

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

Responses

Request samples

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

Response samples

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

Delete stack env var

Deletes a stack-wide environment variable.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

Update stack service revisions

Starts a task that advances unpinned stack services to their eligible revisions.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
query Parameters
scope
string
Default: "all"
Enum: "all" "stateless_only"

Limits the update to all services or stateless services. Defaults to all.

Responses

Response samples

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

Preview stack service revision updates

Returns eligible service revision changes for a stack, optionally limited to one stack service.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
query Parameters
stackServiceId
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Preview stack origin synchronization

Returns the origin stack changes that would be synchronized into the stack.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "previousVersion": "string",
  • "version": "string",
  • "entries": [
    ]
}

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,
  • "serviceRevPinned": true,
  • "outdated": true,
  • "serviceRevId": 0,
  • "serviceRevName": "string",
  • "serviceRevTitle": "string",
  • "serviceRevVersion": "string",
  • "buildSourceIntegrationId": 0,
  • "buildSourceRemoteRepoId": "string",
  • "options": [
    ],
  • "settings": [
    ],
  • "containers": [
    ],
  • "deploymentConfiguration": {
    },
  • "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)
object (ServiceDeploymentConfigurationInput)

Replaces the complete service-level deployment override. An empty object clears it.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "type": "string",
  • "main": true,
  • "disabled": true,
  • "required": true,
  • "replicas": 0,
  • "serviceRevPinned": true,
  • "outdated": true,
  • "serviceRevId": 0,
  • "serviceRevName": "string",
  • "serviceRevTitle": "string",
  • "serviceRevVersion": "string",
  • "buildSourceIntegrationId": 0,
  • "buildSourceRemoteRepoId": "string",
  • "options": [
    ],
  • "settings": [
    ],
  • "containers": [
    ],
  • "deploymentConfiguration": {
    },
  • "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 non-empty
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 non-empty
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

Use 0 for Wodby Blob Storage.

bucket
required
string

Must be empty for Wodby Blob Storage.

storageClass
string or null
Array of objects or null (BackupOption)

Responses

Request samples

Content type
application/json
{
  • "appServiceId": 0,
  • "databaseDbId": 0,
  • "backupName": "string",
  • "integrationId": 0,
  • "bucket": "string",
  • "storageClass": "string",
  • "options": [
    ]
}

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,
  • "backupPresetId": 0,
  • "manual": true,
  • "integrationId": 0,
  • "taskId": 0,
  • "size": 0,
  • "options": [
    ],
  • "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 backup presets

Returns backup presets matching the request filters. At least one target filter is required for user-session requests; API-key requests default to the key's organization.

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

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

backupName
string
applicableEnvId
integer

Return only presets that apply to this environment.

applicableBackupCategory
string
Enum: "files" "database"

Return only presets that apply to this backup category.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create backup preset

Creates a manual or scheduled backup preset.

Authorizations:
apiKeyHeader
Request Body schema: application/json
required
appInstanceId
integer or null
appServiceId
integer or null
databaseId
integer or null
databaseDbId
integer or null
orgId
integer or null

Optional for API-key requests; defaults to the API key's organization when no more specific target is provided.

envId
integer or null
envTypes
Array of strings or null
Enum: "dev" "feature" "test" "staging" "prod"
backupCategory
string or null
Default: "any"
Enum: "any" "files" "database"
backupName
string or null
integrationId
required
integer

Use 0 for Wodby Blob Storage. Free subscriptions may create only an automatic preset that is disabled.

bucket
required
string

Must be empty for Wodby Blob Storage.

storageClass
string or null
Array of objects or null (BackupOption)
disabled
required
boolean
override
required
boolean
auto
boolean or null
crontab
string or null
object (AutomationTimeWindowInput)
duration
integer or null [ 30 .. 180 ]

Responses

Request samples

Content type
application/json
{
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "databaseId": 0,
  • "databaseDbId": 0,
  • "orgId": 0,
  • "envId": 0,
  • "envTypes": [
    ],
  • "backupCategory": "any",
  • "backupName": "string",
  • "integrationId": 0,
  • "bucket": "string",
  • "storageClass": "string",
  • "options": [
    ],
  • "disabled": true,
  • "override": true,
  • "auto": true,
  • "crontab": "string",
  • "timeWindow": {
    },
  • "duration": 30
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "databaseId": 0,
  • "databaseDbId": 0,
  • "orgId": 0,
  • "envId": 0,
  • "envTypes": [
    ],
  • "backupCategory": "any",
  • "backupName": "string",
  • "integrationId": 0,
  • "bucket": "string",
  • "storageClass": "string",
  • "options": [
    ],
  • "override": true,
  • "auto": true,
  • "disabled": true,
  • "crontab": "string",
  • "timeWindow": {
    },
  • "duration": 30,
  • "nextRunAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get backup preset

Returns the backup preset identified by the request path.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "databaseId": 0,
  • "databaseDbId": 0,
  • "orgId": 0,
  • "envId": 0,
  • "envTypes": [
    ],
  • "backupCategory": "any",
  • "backupName": "string",
  • "integrationId": 0,
  • "bucket": "string",
  • "storageClass": "string",
  • "options": [
    ],
  • "override": true,
  • "auto": true,
  • "disabled": true,
  • "crontab": "string",
  • "timeWindow": {
    },
  • "duration": 30,
  • "nextRunAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update backup preset

Updates a backup preset's destination and schedule.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer
Request Body schema: application/json
required
envTypes
Array of strings or null
Enum: "dev" "feature" "test" "staging" "prod"

Omit to preserve the current filter; use an empty array to clear it.

backupCategory
string or null
Enum: "any" "files" "database"

Omit to preserve the current category.

integrationId
required
integer

Use 0 for Wodby Blob Storage. Enabling the preset requires a paid subscription.

bucket
required
string

Must be empty for Wodby Blob Storage.

storageClass
string or null
Array of objects or null (BackupOption)
disabled
required
boolean
override
required
boolean
auto
required
boolean
crontab
string or null
object (AutomationTimeWindowInput)
duration
integer or null [ 30 .. 180 ]

Responses

Request samples

Content type
application/json
{
  • "envTypes": [
    ],
  • "backupCategory": "any",
  • "integrationId": 0,
  • "bucket": "string",
  • "storageClass": "string",
  • "options": [
    ],
  • "disabled": true,
  • "override": true,
  • "auto": true,
  • "crontab": "string",
  • "timeWindow": {
    },
  • "duration": 30
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "databaseId": 0,
  • "databaseDbId": 0,
  • "orgId": 0,
  • "envId": 0,
  • "envTypes": [
    ],
  • "backupCategory": "any",
  • "backupName": "string",
  • "integrationId": 0,
  • "bucket": "string",
  • "storageClass": "string",
  • "options": [
    ],
  • "override": true,
  • "auto": true,
  • "disabled": true,
  • "crontab": "string",
  • "timeWindow": {
    },
  • "duration": 30,
  • "nextRunAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete backup preset

Deletes a backup preset and its schedule.

Authorizations:
apiKeyHeader
path Parameters
id
required
integer

Responses

Response samples

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

List backup preset backups

Returns a paginated list of backups created from the preset.

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

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",
  • "filename": "string",
  • "size": 0,
  • "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

view
string
Enum: "flat" "tree"

Return matching tasks as a flat page or as filter-scoped task trees. Tree responses support user, organization, project, and resource filters, keep paginated roots in items, and include current-page tree nodes in treeItems. Root pages are capped at 100 tasks. Tree responses include up to 250 authorized tasks and set treeTruncated when additional visible descendants exist; exceeding the 10-level depth limit still returns 422.

withoutOrigin
boolean
Deprecated

Deprecated compatibility alias for view=tree

includeSystem
boolean
Default: false

Include operator-only system tasks when authorized

statuses
string

Comma-separated task statuses

names
string

Comma-separated exact task names

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": [
    ],
  • "treeItems": [
    ],
  • "treeTruncated": true,
  • "canIncludeSystem": true,
  • "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",
  • "compactTitle": "string",
  • "executionScope": "user",
  • "status": "string",
  • "progress": 0,
  • "silent": true,
  • "system": true,
  • "userId": 0,
  • "user": {
    },
  • "orgId": 0,
  • "projectIds": [
    ],
  • "appId": 0,
  • "appInstanceId": 0,
  • "appServiceId": 0,
  • "clusterId": 0,
  • "databaseId": 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.

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