Skip to main content

Read a provider specification

Read a provider specification by ID. The JSON schema attribute defines settings for any nullplatform integrations.

Path Parameters
id uuid REQUIRED

Unique identifier for the entity represented as a UUID

Responses
2XX

Object representing a provider specification resource

Schema OPTIONAL
id uuid

Unique identifier for the entity represented as a UUID

name string

Name of the provider specification

slug string

Unique slug for the provider specification

icon string OPTIONAL

Icon for the provider specification

description string OPTIONAL

Description of the provider specification

visible_to string[] OPTIONAL

List of NRNs this specification is visible to

schema object

JSON Schema for the provider specification. This schema defines settings for any Nullplatform integrations.
It can also include custom JSON Schema keywords such as:

  • tag (boolean): Marks a property as auto-taggable, automatically creating a tag with the property's value.
  • secret (boolean): Marks a property as secret, ensuring the property’s value is never revealed.
  • groups (array): Specifies configuration groups within the schema, automatically creating sections in the UI.
allow_dimensions boolean

Flag to allow dimensions for this specification

default_dimensions object OPTIONAL

Default dimensions for the provider specification

tags object[] OPTIONAL

Tags associated with the providers

key string

Tag key

value string

Tag value

id uuid

Unique identifier for the entity represented as a UUID

categories uuid[] OPTIONAL

IDs of associated categories

dependencies uuid[] OPTIONAL

IDs of associated dependencies

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