List environments
Returns a project’s environments, a page at a time.
/project/{project_id}/environmentAuthorizationBearer token (JWT) · headerrequiredJWT token passed in the Authorization header using the Bearer <token> format.
project_iduuidrequiredThe unique identifier for the project
page[limit]integerMaximum number of records to return
page[number]integerPage number
filter[with_deleted]booleanInclude deleted instances
List of environments retrieved successfully
recordsenvironment[]requiredShow propertiesHide properties
environmentiduuidrequiredA universally unique identifier (UUID) string
organization_iduuidrequiredA universally unique identifier (UUID) string
project_iduuidrequiredA universally unique identifier (UUID) string
cluster_iduuidrequiredA universally unique identifier (UUID) string
namestringrequiredThe name of the environment.
typeenvironment_typerequiredThe type of the environment.
developmentstagingproductioncreated_atstring<date-time>requiredThe timestamp when the environment was created.
updated_atstring<date-time>requiredThe timestamp when the environment was last updated.
deleted_atstring<date-time> | nullrequiredThe timestamp when the environment was deleted.
paginationpagination_metarequiredPagination metadata object containing information about the current page, total records, and navigation details for paginated API responses
Show propertiesHide properties
total_recordsintegerrequiredTotal number of records available
current_pageintegerrequiredCurrent page number
total_pagesintegerrequiredTotal number of pages available
next_pageinteger | nullrequiredNext page number, null if no next page exists
prev_pageinteger | nullrequiredPrevious page number, null if no previous page exists
Error
codeinteger<int32>requiredmessagestringrequiredreasonstringOptional stable machine-readable reason for programmatic error handling