Skip to main content

List providers

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

Query Parameters
limit integer

Possible values: 1 ≤ value

Limits the number of results returned per page

offset integer

Specifies the offset for paginating through results

id uuid

Unique identifier for the entity represented as a UUID

nrn NRN REQUIRED

Possible values: Value must match regular expression ^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$

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

specification_id uuid

Unique identifier for the entity represented as a UUID

Provider Specification ID to filter by

show_descendants boolean

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

show_ascendants boolean

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

specification uuid[]

List of provider specification IDs to filter by

include string[]

Possible values: [tags, groups]

Attributes to include in the response

dimensions string

Dimensions for the provider

Responses
2XX

Paginated list of providers

Schema OPTIONAL
paging object
limit integer

Possible values: 1 ≤ value

Limits the number of results returned

offset integer

Specifies the offset for paginated results

results object[]
id uuid

Unique identifier for the entity represented as a UUID

nrn NRN

Possible values: Value must match regular expression ^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$

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

specification_id uuid

Unique identifier for the entity represented as a UUID

attributes object

Provider-specific attributes defined in the specification schema

dimensions object OPTIONAL

NRN-specific dimensions. Read more

tags object[] OPTIONAL

Tags associated with the provider

key string

Tag key

value string

Tag value

id uuid

Unique identifier for the entity represented as a UUID

groups string[] OPTIONAL

Groups associated with the provider

created_at date-time

Creation timestamp

updated_at date-time

Last update timestamp

4XX

Format for representing errors during API interactions

Schema OPTIONAL
statusCode number

HTTP status code indicating the error

code string OPTIONAL

Unique error code for reference and categorization

error string

Short, human-readable error type or category

message string

Detailed error message providing additional context

5XX

Format for representing errors during API interactions

Schema OPTIONAL
statusCode number

HTTP status code indicating the error

code string OPTIONAL

Unique error code for reference and categorization

error string

Short, human-readable error type or category

message string

Detailed error message providing additional context