List a system's effective roles

GET

/systems/{name}/roles

const url = 'https://example.com/api/v1/systems/example/roles';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/systems/example/roles

Every role this system needs filled: those its standard declares (from_standard true) plus those declared directly on it, each with the capabilities it requires, the components filling it, and how many more it wants before quorum (understaffed). A one-off system shows only its own. Gated by system:read; an out-of-scope system is a non-disclosing 404.

Parameters

Path Parameters

name

required

The system’s unique name

string

The system’s unique name

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

roles

required

Array<object> | null

object

assigned

required

How many components fill the role

integer format: int64

assigned_to

required

The component names filling this role in this system

Array<string> | null

capabilities

required

The capabilities a component must ALL provide to fill it

Array<string> | null

display_name

required

string

from_standard

required

True when the role is inherited from the system’s standard; false when declared on the system

boolean

impact

required

What an impaired role means for its system: outage, degraded, or none

string

name

required

string

quorum

required

integer format: int64

understaffed

required

How many more the role wants before quorum; zero when staffed

integer format: int64

system

required

string

Example

{
  "$schema": "/api/v1/schemas/ListSystemRolesOutputBody.json"
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}