Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Tool

Get tool versions

get/v1/{organization}/tool/{tool_id}/version

Path parameters

organizationstring required
tool_idstring required

The ID of the tool to retrieve versions for.

The ID of the tool to retrieve versions for.

Query parameters

deprecatedboolean nullable

Whether to filter by deprecated tool versions.

Whether to filter by deprecated tool versions.

versionsstring nullable

A semver constraint that specifies the versions to retrieve.

A semver constraint that specifies the versions to retrieve.

sort_bystring[]

The fields to sort the versions by. Supported fields are created_at, version.major, version.minor, version.patch, and deprecated. 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 created_at, version.major, version.minor, version.patch, and deprecated. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

creatorstring[]

The creators of the tool versions. Each value must be of the format org_id,user_id.

The creators of the tool versions. Each value must be of the format org_id,user_id.

limitinteger

The maximum number of tool versions to return.

The maximum number of tool versions to return.

continuation_tokeninteger

The continuation token from the previous request used to retrieve the next page of tool versions.

The continuation token from the previous request used to retrieve the next page of tool versions.

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 tool versions to retrieve.

{"stackTrail":"components:schemas:src__app__endpoints__tool__get_tool_versions__Response:properties:continuation_token:anyOf","oasType":"schema","type":"unknown","title":"Continuation Token","description":"A token to supply to the next request to retrieve the next page of tool versions. Only populated if `has_more` is `True`.","nullable":true}