Patch agent version

PATCH

/api/v1/agents/{id}/versions/{agentVersion}

const url = 'https://example.com/api/v1/agents/example/versions/example';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: '{"status":"active"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://example.com/api/v1/agents/example/versions/example \
  --header 'Content-Type: application/json' \
  --data '{ "status": "active" }'

Parameters

Path Parameters

required

string

agentVersion

required

string

Request Body

application/json

object

status

required

string

Allowed values: active retired

Responses

200

Success

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

Invalid status value

404

Agent or version not found

409

Queue is assigned to another agent

503

Concurrent activation did not stabilize