Skip to content
Scope

Register agent version (upsert)

POST
/api/v1/agents/{id}/versions
 
curl --request POST \
  --url https://example.com/api/v1/agents/example/versions \
  --header 'Content-Type: application/json' \
  --data '{ "agentVersion": "example", "workerVersion": "example", "components": { "additionalProperty": "example" }, "gitCommit": "example", "buildTime": "example", "imageTag": "example", "queueName": "example" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body

Section titled “Request Body ”
Media type application/json
object
agentVersion
required
string
>= 1 characters
workerVersion
required
string
>= 1 characters
components
required
object
key
additional properties
string
gitCommit
required
string
>= 1 characters
buildTime
required
string
>= 1 characters
imageTag
required
string
>= 1 characters
queueName
required
string
>= 1 characters
Example generated
{
  "agentVersion": "example",
  "workerVersion": "example",
  "components": {
    "additionalProperty": "example"
  },
  "gitCommit": "example",
  "buildTime": "example",
  "imageTag": "example",
  "queueName": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Success

Media type application/json
object
agentVersion
required
string
>= 1 characters
workerVersion
required
string
>= 1 characters
components
required
object
key
additional properties
string
gitCommit
required
string
>= 1 characters
buildTime
required
string
>= 1 characters
imageTag
required
string
>= 1 characters
queueName
string
status
required
string
Allowed values: active retired
createdAt
required
string | null format: date-time
Example 
{
  "status": "active"
}

400

Section titled “400 ”

Validation error

404

Section titled “404 ”

Agent not found

409

Section titled “409 ”

Queue is assigned to another agent

503

Section titled “503 ”

Concurrent registration did not stabilize