List systems

GET

Returns an array of system records for the authenticated environment.

Query parameters

• limit: optional positive integer, maximum 1000, default 200; use it to restrict the number of returned systems
• expand: optional comma-separated string; supported token: counts; when used, each response item also includes counts.totalNodes and counts.totalMetrics

Response

• 200 OK

[
  {
    "systemId": 1,
    "name": "Production",
    "systemType": "cluster",
    "systemTypeId": "3",
    "counts": {
      "totalNodes": 24,
      "totalMetrics": 320
    }
  },
  {
    "systemId": 2,
    "name": "Staging",
    "systemType": "stage-cluster",
    "systemTypeId": "7",
    "counts": {
      "totalNodes": 12,
      "totalMetrics": 144
    }
  }
]

Response item fields

Field	Type	Description
systemId	integer	System identifier
name	string | null	System name
systemType	string | null	System type
systemTypeId	string | null	System type identifier
counts.totalNodes	integer	Total nodes in the system, present when expand=counts is used
counts.totalMetrics	integer	Total metrics in the system, present when expand=counts is used

Errors

• 400: invalid query parameters
• 401: unauthorized
• 403: forbidden