List component variables
Returns the variables set on the component, a page at a time.
/project/{project_id}/environment/{environment_id}/component/variableAuthorizationBearer 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_kindrequiredThe kind of component
KjobKApplicationKHelmKDatabasecomponent_iduuidrequiredThe unique identifier for the component
include_inheritedbooleanInclude inherited records from project and environment scopes.
page[limit]integerMaximum number of records to return
page[number]integerPage number
List of variables retrieved successfully
recordsvariable[]requiredShow propertiesHide properties
variableiduuidrequiredA universally unique identifier (UUID) string
organization_iduuidrequiredA universally unique identifier (UUID) string
project_iduuidrequiredA universally unique identifier (UUID) string
environment_iduuid | nullShow propertiesHide properties
string<uuid>nullvisibilityvariable_visibilityrequiredVariable scope visibility
projectenvironmentcomponentvar_typevariable_typerequiredVariable value type
key_valuefilekeystringrequiredVariable key identifier.
is_secretbooleanrequiredIndicates whether the value is stored in Vault.
managedbooleanrequiredIndicates whether the variable is managed by the engine and cannot be updated or deleted through the API.
valuestring | nullVariable value. Null for secret variables.
file_pathstring | nullAbsolute file path for file variables.
component_kindcomponent_kind | nullShow propertiesHide properties
stringnullcomponent_iduuid | nullShow propertiesHide properties
string<uuid>nullcreated_atstring<date-time>requiredThe timestamp when the variable was created.
updated_atstring<date-time>requiredThe timestamp when the variable was last updated.
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