Skip to main content

Read a service

Read a service

Path Parameters
id uuid REQUIRED

Unique identifier for the entity represented as a UUID

Responses
2XX

Object representing service instances

Schema OPTIONAL
id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

name string OPTIONAL

Possible values: 1 ≤ length

Name of the entity. Must be a non-empty string and not equal to null

slug string OPTIONAL

Possible values: 1 ≤ length

Slug of the entity. Automatically generated from "name"

specification_id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

desired_specification_id OPTIONAL

Desired unique identifier for the associated specification

messages object[] OPTIONAL
level string OPTIONAL

Possible values: [debug, info, information, warn, warning, error, fatal]

Message severity level. Defaults to "info"

message string

The actual message content

created_at date OPTIONAL
updated_at date OPTIONAL
status string OPTIONAL

Possible values: [pending_create, pending, creating, updating, deleting, active, deleted, failed]

Status of the service. Should be one of the specified values in the enumeration

linkable_to NRN[] OPTIONAL

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

Array representing visibility settings for the entity. Specifies what/who can see this entity

dimensions object OPTIONAL

Object representing dimensions with key-value pairs

attributes object OPTIONAL

Attributes associated with the service, should be valid against the service specification attribute schema

entity_nrn NRN OPTIONAL

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

selectors object OPTIONAL

Key-value object representing instance selectors

imported boolean OPTIONAL
provider string OPTIONAL

Possible values: 1 ≤ length

category string OPTIONAL

Possible values: 1 ≤ length

sub_category string OPTIONAL

Possible values: 1 ≤ length

type string OPTIONAL

Possible values: [dependency, scope]

Type of the service. Should be one of the specified values in the enumeration

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