Skip to content
Kapten
Esc
↑↓navigate↵open⌘Jpreview

List component variables

Returns the variables set on the component, a page at a time.

GET/project/{project_id}/environment/{environment_id}/component/variable
Authorization
AuthorizationBearer token (JWT) · headerrequired

JWT token passed in the Authorization header using the Bearer <token> format.

Path parameters
project_iduuidrequired

The unique identifier for the project

environment_iduuidrequired

The unique identifier of the environment

Query parameters
component_kindcomponent_kindrequired

The kind of component

Allowed:KjobKApplicationKHelmKDatabase
component_iduuidrequired

The unique identifier for the component

include_inheritedboolean

Include inherited records from project and environment scopes.

default: false
page[limit]integer

Maximum number of records to return

min 1 · max 100 · default: 10
page[number]integer

Page number

min 1 · default: 1
Responses
200

List of variables retrieved successfully

recordsvariable[]required
Show properties
Array of variable
iduuidrequired

A universally unique identifier (UUID) string

organization_iduuidrequired

A universally unique identifier (UUID) string

project_iduuidrequired

A universally unique identifier (UUID) string

environment_iduuid | null
Show properties
Any of:
uuid
string<uuid>
null
null
visibilityvariable_visibilityrequired

Variable scope visibility

Allowed:projectenvironmentcomponent
var_typevariable_typerequired

Variable value type

Allowed:key_valuefile
keystringrequired

Variable key identifier.

is_secretbooleanrequired

Indicates whether the value is stored in Vault.

managedbooleanrequired

Indicates whether the variable is managed by the engine and cannot be updated or deleted through the API.

valuestring | null

Variable value. Null for secret variables.

file_pathstring | null

Absolute file path for file variables.

component_kindcomponent_kind | null
Show properties
Any of:
component_kind
string
null
null
component_iduuid | null
Show properties
Any of:
uuid
string<uuid>
null
null
created_atstring<date-time>required

The timestamp when the variable was created.

updated_atstring<date-time>required

The timestamp when the variable was last updated.

paginationpagination_metarequired

Pagination metadata object containing information about the current page, total records, and navigation details for paginated API responses

Show properties
total_recordsintegerrequired

Total number of records available

current_pageintegerrequired

Current page number

total_pagesintegerrequired

Total number of pages available

next_pageinteger | nullrequired

Next page number, null if no next page exists

prev_pageinteger | nullrequired

Previous page number, null if no previous page exists

default

Error

codeinteger<int32>required
messagestringrequired
reasonstring

Optional stable machine-readable reason for programmatic error handling

Request
curl -X GET 'https://api.kapten.io/project/497f6eca-6276-4993-bfeb-53cbbbba6f08/environment/497f6eca-6276-4993-bfeb-53cbbbba6f08/component/variable?component_kind=Kjob&component_id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "records": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
      "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
      "visibility": "project",
      "var_type": "key_value",
      "key": "string",
      "is_secret": true,
      "managed": true,
      "value": "string",
      "file_path": "string",
      "component_kind": "Kjob",
      "component_id": "41afafe5-2a48-424a-baef-34c2ad44ef7b",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "total_records": 100,
    "current_page": 1,
    "total_pages": 10,
    "next_page": 2,
    "prev_page": null
  }
}

Was this page helpful?