Sign in
Parameter

Create a single parameter value

Create a value for a parameter, either for an application or a scope.

post/parameter/{id}/value

Path parameters

idstring required

The ID of the parameter.

Request body

origin_versioninteger

The ID of the parameter version. Use this field to create a new value by copying values from a specific version (i.e., roll back).

Note: You can retrieve the version ID by calling the List parameter versions endpoint.

nrnstring required

The NRN of the application or scope to which the value applies.

Note: For dimension settings, the NRN must be at the application-level.

valuestring required

The content of the value. Cannot exceed 2KB for environment variables and 2MB for files.

dimensionsobject

The dimensions of the value.

Example request

{
  "origin_version": 1,
  "nrn": "organization=1:account=2:namespace=3:application=4:scope=5",
  "value": "200",
  "dimensions": {
    "environment": "development",
    "country": "US"
  }
}

Response

The operation was successful.

idinteger required

A system-wide unique ID for the value.

nrnstring required

The NRN of the application which the parameter belongs to.

created_atstring date-time required

The ISO-8601 UTC timestamp of when the parameter value was created.

valuestring nullable

The value of the parameter.<br><br>

Note: If show_secret_values is set to true, the value is only visible to users with the required permission. See Accessing secret values for more details.

locationstring

The file path. Applicable only for files; null otherwise. Also null for secrets.

dimensionsobject

The dimensions of the value.

Example response

{
  "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.