NUnullplatform
Provider

List providers

Get a paginated list of providers filtered by NRN and other queries

get/provider

Request

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

Query parameters

limitinteger

Limits the number of results returned per page

offsetinteger

Specifies the offset for paginating through results

idstring uuid

Unique identifier for the entity represented as a UUID

nrnstring required

Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources

dimensionsstring

Dimensions for the query, formatted as key:value pairs separated by commas (e.g., "key1:value1,key2:value2")

specification_idstring
Example:7f3c910e-8138-4d65-9d09-b97d89f2c509,82eee42c-46c9-4bb7-a53d-c08b027817f3

Provider Specification ID to filter by, it supports comma separated values

specification_slugstring
Example:aws-configuration,gitlab-configuration

Provider Specification slug to filter by, it supports comma separated values

show_descendantsboolean

Specifies whether to show entities defined in the lower level of the NRN hierarchy

show_ascendantsboolean

Specifies whether to show entities defined in the lower level of the NRN hierarchy

specificationDef0[]

List of provider specification IDs to filter by

includestring[]

Attributes to include in the response

Response

Paginated list of providers

Example response

{
  "results": [
    {
      "id": "a3f1c2d4-e5b6-7890-ab12-cdef34567890",
      "nrn": "organization=1:account=1:namespace=1",
      "dimensions": {
        "environment": "production"
      },
      "specification_id": "02fd22f1-6bf9-41aa-9b58-29d50f725855",
      "attributes": {
        "cluster": {
          "id": "my-np-gcp-prod",
          "location": "s-west1",
          "namespace": "my-namespace"
        },
        "gateway": {
          "public_name": "my-public-gateway",
          "private_name": "my-private-gateway"
        }
      },
      "tags": [
        {
          "id": "4e2306de-82e3-4b74-a419-e0e324beb500",
          "key": "cluster.id",
          "value": "my-np-gcp-prod"
        }
      ],
      "created_at": "2024-10-15T08:30:00Z",
      "updated_at": "2024-10-20T14:45:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 17 revisions of this API.