Sign in
NRN

Read an NRN

Read an NRN by ID.

⚠️ Deprecation notice

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

get/nrn/{nrn}

Path parameters

nrnstring required

The NRN to read.

Query parameters

idsstring required

A comma-separated list of elements to retrieve, following the ${namespace}.${key} convention.

  • The namespace can be omitted for the global namespace.
  • This convention also allows retrieving values inside profiles.
profilestring

A comma-separated list of profiles.

output_json_valuesboolean

If true, the API parses the values and represents them as JSON objects.

no-mergeboolean

If true, results are not merged with parent nodes in the hierarchy.

array_merge_strategy'merge' | 'no_merge'

Whether JSON arrays should be merged or overridden.

Response

The operation was successful.

nrnstring required

A system-wide unique ID for resource.

namespacesobject required

An object where each key represents a namespace, and its value is an object containing key-value pairs.

profilesobject required

An object containing the profiles available for this NRN.

Example response

{
  "nrn": "organization=1:account=2",
  "namespaces": {
    "namespaces": {
      "global": {
        "some-key": "some-value"
      }
    }
  },
  "profiles": {
    "profiles": {
      "development": {
        "some-namespace": {
          "some-key": "some-value"
        },
        "production": {
          "some-namespace": {
            "some-key": "another-value"
          }
        }
      }
    }
  }
}

Changes