v1

latestOpenAPI 3.1.02026-08-04151221521.2 KB
Versions

Register Container

Register an agent container that has started up.

Called by the agent container on startup to:
1. Register its ACP URL with the platform
2. Receive its API key for authenticating subsequent requests

This endpoint should be called from within the container's entrypoint
after the ACP server is ready to receive traffic.
post/versions/register

Request body

acp_urlstring required
branch_idstring required

Branch ID

registration_tokenstring nullable

Single-use registration token provided during deployment (required when configured)

version_idstring required

Version ID being registered

Response

Successful Response

agent_api_keystring required

API key for the agent

agent_idstring required

Agent ID

agent_namestring required

Agent name

branch_idstring required

Branch ID

version_status'DEPLOYING' | 'ACTIVE' | 'FAILED' | 'UNHEALTHY' | 'DRAINING' | 'RETIRED' | 'ROLLED_BACK' required

Status of a version in its lifecycle.