List environment components
Returns the applications, jobs and databases of an environment, a page at a time.
/project/{project_id}/environment/{environment_id}/componentsAuthorizationBearer token (JWT) · headerrequiredJWT token passed in the Authorization header using the Bearer <token> format.
project_iduuidrequiredThe unique identifier for the project
environment_iduuidrequiredThe unique identifier of the environment
component_kindcomponent_kindOptional component kind filter
KjobKApplicationKHelmKDatabasepage[limit]integerMaximum number of records to return
page[number]integerPage number
filter[with_deleted]booleanInclude deleted instances
Environment components retrieved successfully
recordscomponent[]requiredShow propertiesHide properties
componentiduuidrequiredA 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
environment_iduuidrequiredA universally unique identifier (UUID) string
s_idstringrequiredShort identifier for the component resource.
namestringrequiredComponent name.
descriptionstringOptional component description.
kindcomponent_kindrequiredComponent family.
KjobKApplicationKHelmKDatabasesubtypestringrequiredComponent subtype within its family, such as a database engine or job type.
created_atstring<date-time>requiredTimestamp when the component was created.
updated_atstring<date-time>requiredTimestamp when the component was last updated.
deleted_atstring<date-time> | nullTimestamp when the component was deleted.
last_run_iduuid | nullLast attempted component run identifier.
Show propertiesHide properties
string<uuid>nulllast_run_statuscomponent_deployment_state | nullLast attempted component run status.
Show propertiesHide properties
stringnullresource_statecomponent_resource_staterequiredCurrent component resource state.
OUT_OF_DATEUP_TO_DATENEVER_DEPLOYEDpaginationpagination_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