Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Organization

Get agent versions

Retrieve the versions of an agent.

Permissions

This endpoint requires the following permissions:

  • Organization:GetAgent for the agent to retrieve.
get/v1/{organization}/organization/agent/{agent_id}/version

Path parameters

agent_idstring required

The ID of the agent.

The ID of the agent.

organizationstring required

Query parameters

versionstring nullable

The versions of the agent to retrieve. One can specify an exact version to retrieve, which is either the version number or latest, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by -, and every version within the range would be retrieved.

Example:1

The versions of the agent to retrieve. One can specify an exact version to retrieve, which is either the version number or latest, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by -, and every version within the range would be retrieved.

limitinteger

The maximum number of agent versions to return.

The maximum number of agent versions to return.

continuation_tokeninteger

The continuation token from the previous request used to retrieve the next page of agent version.

The continuation token from the previous request used to retrieve the next page of agent version.

sort_bystring[]

The fields to sort the versions by. Supported fields are version. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

The fields to sort the versions by. Supported fields are version. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.

has_moreboolean required

Whether there are more agent versions to retrieve.

continuation_tokeninteger nullable required

A token to supply to the next request to retrieve the next page of agent versions. Only populated if has_more is True.