Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Environments

List Environments

Lists all the environments under a given project.

get/v2/projects/{proj_id}/envs

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Query parameters

pageinteger

Page number of the results to fetch, starting at 1.

Page number of the results to fetch, starting at 1.

per_pageinteger

The number of results per page (max 100).

The number of results per page (max 100).

Response

Successful Response

keystring required

A URL-friendly name of the environment (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the environment.

idstring uuid required

Unique id of the environment

organization_idstring uuid required

Unique id of the organization that the environment belongs to.

project_idstring uuid required

Unique id of the project that the environment belongs to.

created_atstring date-time required

Date and time when the environment was created (ISO_8601 format).

updated_atstring date-time required

Date and time when the environment was last updated/modified (ISO_8601 format).

avp_policy_store_idstring
namestring required

The name of the environment

descriptionstring

an optional longer description of the environment

custom_branch_namestring

when using gitops feature, an optional branch name for the environment

settingsobject

the settings for this environment

email_configurationstring uuid required