Skip to main content

Read a parameter

Retrieve a parameter by ID

Path Parameters
id string REQUIRED

The ID of the parameter

Responses
200

Parameters

Schema OPTIONAL
id integer

A system-wide unique ID representing the resource

nrn string

The NRN of the application to which the parameter belongs to

type string

Possible values: [environment, file]

encoding string

Possible values: [plaintext, base64]

variable string OPTIONAL

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

destination_path string OPTIONAL

The full path for file. Required when type = file

secret boolean

Possible values: [true, false]

'true' if the value is a secret, 'false' otherwise

read_only boolean

Possible values: [true, false]

'true' if the value is read only, 'false' otherwise

version_id integer

A system-wide unique ID representing the version of the parameter

values object[]
id integer

A system-wide unique ID representing the value

nrn string

The NRN of the application to which the parameter belongs to

created_at string

The ISO 8859 UTC date for this version creation

value string OPTIONAL

The content of the environment variable (only for environment variables, otherwise null). Also null for secrets.

location string OPTIONAL

The location of the file (only for files, otherwise null). Also null for secrets.