Account5

Action36

Action Item12

Action Item Category5

Action Item Comment2

Agent3

Announcements6

API keys5

Application4

Approval6

Artifact7

Asset4

Authentication1

Build4

Catalog instance (multiple keys)3

Catalog instance (single key)4

Catalog specification5

Category2

Channel5

Checklist6

Custom domain5

Deployment4

Deployment group4

Deployment strategy5

Dimension5

Dimension value1

Dimension Value4

Entity hook8

Event3

Inbox rules12

Link12

Log config4

Log specification5

Log template4

Namespace5

NRN5

Organization2

Package10

Parameter11

Personal access tokens5

Policy5

Provider6

Provider Specification5

Query1

Release4

Report versions8

Reports6

Role and grant5

Runtime Configuration5

Scope10

Scope type5

Service15

Suggestion8

Technology template5

User4

Workflow aliases7

Workflow definitions7

Workflow engine1

Workflow executions10

Workflow plugins2

Workflow revisions2

Workflow secrets and variables5

Workflow signals3

Workflow triggers1

Parameter

Create a parameter

Changed on Oct 19, 2026

Create an application parameter.

post/parameter

Request

Base URL
https://api.nullplatform.com
URL
https://api.nullplatform.com/parameter
Auth
HTTP bearer

Request body

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.

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.

variablestring

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

destination_pathstring

The full file path. Required when type is file.

Example request

{
  "name": "Pool Size",
  "nrn": "organization=1:account=2:namespace=3:application=4",
  "type": "environment",
  "encoding": "plaintext",
  "variable": "POOL_SIZE",
  "secret": false,
  "read_only": false,
  "values": [
    {
      "nrn": "organization=1:account=2:namespace=3:application=4",
      "value": "10"
    },
    {
      "nrn": "organization=1:account=2:namespace=3:application=4",
      "value": "50",
      "dimensions": {
        "environment": "production"
      }
    }
  ]
}

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

Oct 19, 2026bb78d8aa6d40 Revision changes
- info
  added the new optional request property
Oct 15, 2026728d4df70ca1 Revision changes
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  response property message deprecated
- info
  response property message deprecated
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history