Sign in
Parameter

Read a parameter

Retrieve a parameter by ID.

get/parameter/{id}

Path parameters

idstring required

The ID of the parameter.

Query parameters

show_secret_valuesboolean

Whether to show secret values in the response.<br><br>

ℹ️ Note: If set to true, secret values will be visible only to users with the required permission; otherwise, they will be hidden. See Accessing secret values for more details.

dimensionsstring

Limits which secret values are revealed when show_secret_values is true. Specify dimensions as comma-separated key:value pairs. Only the values matching these dimensions are returned with their content; every other value stays hidden.<br><br>

ℹ️ Note: Users without the permission to read secret values need an approval that covers the requested dimensions. See Accessing secret values for more details.

Response

The operation was successful.

idinteger required

A system-wide unique ID for the parameter.

namestring required

The name of the parameter.

nrnstring required

The NRN of the application which the parameter belongs to.

type'environment' | ' file' required

The type of the parameter.

encoding'plaintext' | ' base64' required

The encoding of the parameter value.

variablestring

The name of the environment variable. Required when type is environment.

destination_pathstring

The full file path. Required when type is file.

secrettrue | false required

Indicates whether the value is a secret. true if it is a secret, false otherwise.

read_onlytrue | false required

Indicates whether the value is read-only. true if it is read-only, false otherwise.

version_idinteger required

A system-wide unique ID for the parameter version.

Example response

{
  "id": 1234,
  "name": "Pool Size",
  "nrn": "organization=1:account=2:namespace=3:application=4",
  "type": "environment",
  "encoding": "plaintext",
  "version_id": 12341234,
  "values": [
    {
      "id": 1234,
      "nrn": "organization=1:account=2:namespace=3:application=4",
      "created_at": "2021-01-02T00:00:00Z",
      "value": "200",
      "external": {
        "id": "external_id_123",
        "engine": "hcp_vault"
      },
      "dimensions": {
        "environment": "development",
        "country": "US"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.