Create a service template in an environment

POST

/api/environments/{envId}/services

curl --request POST \
  --url https://example.com/api/environments/example/services \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "containerImageId": "example", "imageTag": "latest", "composeTemplate": "example", "healthCheckUrl": "example", "baseEnv": { "additionalProperty": "example" }, "deployStrategy": "sequential" }'

Authorizations

• bearerAuth

Parameters

Path Parameters

envId

required

string

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters

containerImageId

required

string

>= 1 characters

imageTag

string

default: latest

composeTemplate

string

nullable

healthCheckUrl

string

nullable

baseEnv

object

key

additional properties

string

deployStrategy

string

Allowed values: sequential parallel

Responses

400

Bad request — malformed input or failed validation.

Media typeapplication/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}

401

Unauthorized — missing or invalid bearer token.

Media typeapplication/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}

409

Conflict — e.g. a unique constraint violation.

Media typeapplication/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}