deploy module route (requires deploy:deployment:write)

POST

/v1/m/deploy/definitions

curl --request POST \
  --url https://example.com/v1/m/deploy/definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "environment": "example", "name": "example", "runtime": "example", "source_ref": "example", "spec": { "command": "example", "env_refs": [ { "name": "example", "secret_ref": "example" } ], "identity": { "identity_ref": "example", "mint": true }, "image": "example", "replicas": 1, "resources": { "additionalProperty": "example" }, "wirings": [ { "mode": "example", "resource_kind": "example", "resource_ref": "example", "secret_ref": "example" } ] }, "subject_kind": "example", "subject_ref": "example", "target": "example" }'

• this engine

Returns HTTP 501 because deployment is a Business feature; no deployment action is performed.

Authorizations

• bearerAuth
• browserSession

Parameters

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

The handler accepts one JSON document and caps decoding at 256 KiB.

Media type application/json

object

environment

required

After Unicode whitespace trimming, the handler requires a non-empty value of at most 200 UTF-8 bytes.

string

name

required

After Unicode whitespace trimming, the handler requires a non-empty value of at most 200 UTF-8 bytes.

string

runtime

Any of:

string

The handler limits this value to 200 UTF-8 bytes.

string

null

null

source_ref

Any of:

string

The handler limits this value to 512 UTF-8 bytes and rejects values that look like inline credential material.

string

null

null

spec

required

Any of:

object

object

command

Any of:

string

The handler limits this value to 2048 UTF-8 bytes and rejects values that look like inline credential material.

string

null

null

env_refs

Any of:

Array<object>

Array<object>

<= 200 items

object

name

required

After Unicode whitespace trimming, the handler requires a non-empty value of at most 200 UTF-8 bytes and rejects inline credential material.

string

secret_ref

Any of:

string

Empty or at most 512 UTF-8 bytes in : form. The handler case-insensitively allowlists vault, infisical, aws-secretsmanager, gcp-secretmanager, azure-keyvault, k8s-secret, env and file, and rejects empty locators or inline credentials.

string

null

null

null

null

identity

Any of:

object

Any of:

object

object

identity_ref

required

string

>= 1 characters

mint

Any of:

boolean

boolean

null

null

object

object

identity_ref

Any of:

string

The handler limits this value to 512 UTF-8 bytes and rejects values that look like inline credential material.

string

null

null

mint

required

null

null

image

Any of:

string

The handler limits this value to 2048 UTF-8 bytes and rejects values that look like inline credential material.

string

null

null

replicas

Any of:

integer

integer

<= 10000

null

null

resources

Any of:

object

The handler limits every key and value to 200 UTF-8 bytes and rejects inline credential material; a JSON null value decodes to an empty string.

object

key

additional properties

Any of:

string

The handler limits this value to 200 UTF-8 bytes.

string

null

null

null

null

wirings

Any of:

Array<object>

Array<object>

<= 200 items

object

mode

required

Trimmed and lowercased by the handler; the normalized value must be read, write or readwrite.

string

resource_kind

required

After Unicode whitespace trimming, the handler requires a non-empty value. The handler limits this value to 200 UTF-8 bytes and rejects values that look like inline credential material.

string

resource_ref

required

After Unicode whitespace trimming, the handler requires a non-empty value. The handler limits this value to 512 UTF-8 bytes and rejects values that look like inline credential material.

string

secret_ref

Any of:

string

Empty or at most 512 UTF-8 bytes in : form. The handler case-insensitively allowlists vault, infisical, aws-secretsmanager, gcp-secretmanager, azure-keyvault, k8s-secret, env and file, and rejects empty locators or inline credentials.

string

null

null

null

null

null

null

subject_kind

required

Trimmed and lowercased by the handler; the normalized value must be agent or mcp_server.

string

subject_ref

required

After Unicode whitespace trimming, the handler requires a non-empty value of at most 512 UTF-8 bytes.

string

target

required

After Unicode whitespace trimming, the handler requires a non-empty value. The handler limits this value to 512 UTF-8 bytes and rejects values that look like inline credential material.

string

Responses

200

OK

Media type application/json

object

Example ^generated

{}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}