Sign in
Provider Specification

Read a provider specification

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

get/provider_specification/{id}

Path parameters

idstring uuid required

Unique identifier for the entity represented as a UUID

Response

Object representing a provider specification resource

idstring uuid required

Unique identifier for the entity represented as a UUID

namestring required

Name of the provider specification

slugstring required

Unique slug for the provider specification

iconstring

Icon for the provider specification

descriptionstring

Description of the provider specification

visible_tostring[]

List of NRNs this specification is visible to

schemaobject required

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_dimensionsboolean required

Flag to allow dimensions for this specification

default_dimensionsobject

Default dimensions for the provider specification

categoriesDef0[]

IDs of associated categories

dependenciesDef0[]

IDs of associated dependencies

organization_idinteger nullable

Organization ID that owns this specification. NULL means global (nullplatform-managed)

created_atstring date-time required

Creation timestamp

updated_atstring date-time required

Last update timestamp

Changes

No recorded changes to this endpoint across all 1 revision of this API.