Runtime Configuration

Create a runtime configuration

Changed on

Creates an runtime configuration.

⚠️ Deprecation notice

This operation might be removed in the future. We recommend using Providers instead.

post/runtime_configuration

Request

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

Request body

nrnstring required

NRN (at or below) where the runtime configuration applies.

dimensionsobject required

The set of dimension/value pairs that this runtime configuration applies to.

You can send an empty object {} to create a runtime configuration that applies to all dimensions.

valuesobject required

The set of values that this runtime configuration holds.

Example request

{
  "nrn": "organization=1:account=2:namespace=3",
  "dimensions": {
    "environment": "production",
    "country": "us"
  },
  "values": {
    "aws": {
      "log_reader": "...",
      "workflow_role": "..."
    }
  }
}

Response

The operation was successful.

idinteger required

A system-wide unique ID for the runtime configuration.

nrnstring required

NRN (at or below) where the runtime configuration applies.

profilestring required

An identifier for this runtime configuration based on the dimensions on which it was created.

status'active' | 'inactive' required

The status of the runtime configuration.

dimensionsobject required

The set of dimension/values that this runtime configuration is providing values for.

valuesobject

The set of values that this runtime configuration holds.

Example response

{
  "id": 1234,
  "nrn": "organization=1:account=2:namespace=3",
  "profile": "environment_dev_country_arg",
  "status": "active",
  "dimensions": {
    "environment": "dev",
    "country": "arg"
  },
  "values": {
    "workflow": "null_dev",
    "aws": {
      "log_reader": "..."
    }
  }
}

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