v1

latestOpenAPI 3.1.02026-07-176644123.6 KB
api

Api List Environments V2

Retrieve a list of environments.

Parameters

auth : Authentication Authentication instance for the request. Used to get role bindings and filter environments returned to those visible by the user making the request entity : AuthenticationToken Token of the user making the request paginated_args : CursorPaginatedArgs Arguments for controlling pagination of the response conda_store : app.CondaStore The running conda store application search : Optional[str] If specified, filter by environment names or namespace names containing the search term namespace : Optional[str] If specified, filter by environments in the given namespace name : Optional[str] If specified, filter by environments with the given name status : Optional[schema.BuildStatus] If specified, filter by environments with the given status packages : Optional[List[str]] If specified, filter by environments containing the given package name(s) artifact : Optional[schema.BuildArtifactType] If specified, filter by environments with the given BuildArtifactType jwt : Optional[auth_schema.AuthenticationToken] If specified, retrieve only the environments accessible to this token; that is, only return environments that the user has 'admin', 'editor', and 'viewer' role bindings for.

Returns

schema.APIListEnvironment Paginated JSON response containing the requested environments. Cursor-based pagination is used.

Note that the Environment objects returned here have their `current_build` fields omitted
to keep the repsonse size down; these fields otherwise drastically increase the response
size.
get/api/v2/environment/

Query parameters

artifact'DIRECTORY' | 'LOCKFILE' | 'LOGS' | 'YAML' | 'CONDA_PACK' | 'DOCKER_MANIFEST' | 'CONSTRUCTOR_INSTALLER' | 'CONTAINER_REGISTRY' | 'DOCKER_BLOB'
jwtstring nullable
namestring nullable
namespacestring nullable
packagesstring[] nullable
searchstring nullable
status'QUEUED' | 'BUILDING' | 'COMPLETED' | 'FAILED' | 'CANCELED'
order'asc' | 'desc'
limitinteger nullable
sort_bystring[]
cursorstring nullable

Response

Successful Response

countinteger required
cursorstring nullable
messagestring nullable
status'ok' | 'error' required