Site Summary

Summary of the status of a site.

Retrieve all site summaries

SecurityaccessToken

Request

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
keys	string <enumeration> Retrieve only the keys for the list Value: "true"
count	string <enumeration> Retrieve only the number of elements in the list Value: "true"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/system/site-status/sites

Response samples

- name: udc1
  type: edge
  descriptive-name: my site
  locally-modified: false
  hosts: 3
  hosts-called-home: 3
  hosts-in-distress: 0
  cluster-established: true
  connection-state:
    connected: true
    last-connect: 2023-03-14T15:32:29.099Z
    last-disconnect: unknown
  location:
    latitude: 51.98635
    longitude: 11.98635
  tenants: 1
  deployed-applications: true

Retrieve a site summary

SecurityaccessToken

Request

path Parameters

site-summary-name

required

string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

The name of the site.

query Parameters

fields

string

Retrieve only requested fields from the resource

See section fields