API ReferenceIntegrations

Deploy custom Docker

Creates a server and queues deployment. deploymentId identifies the created server; use /api/servers/{id} and its jobs to follow progress. Manifest defaults and entitlements apply.

Requires every scope: deployments:write.

Authentication

AuthorizationBearer

JWT returned by POST /api/auth/token-exchange. Amazon and authorization invitations require API-key-derived tokens.

Request

This endpoint expects an object.
environmentIddoubleRequired
serverNamestringRequired>=1 character
Trimmed name.
imageSourceTypeenumRequired
containerImagestringRequired>=1 character

Valid Docker repository, such as nginx, org/repo, or registry.example.com:5000/org/repo.

containerPortdoubleOptionalDefaults to 8080
healthCheckPathstringOptionalDefaults to /health
environmentVariablesmap from strings to stringsOptional
cpudoubleOptional
memorydoubleOptional
desiredCountdoubleOptional1-10Defaults to 1
containerTagstringOptionalformat: "^[\w][\w.-]{0,127}$">=1 characterDefaults to latest

Response

Success
successboolean
deploymentIdinteger
jobIdinteger
statusenum
messagestring
integrationobjectOptional
hasSecretsbooleanOptional
backendsCountintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error
503
Service Unavailable Error