cURL

curl --request GET \
  --url http://localhost/v1/controls/clusters \
  --header 'X-API-Key: <api-key>'

{
  "activeClusters": [
    {
      "id": "<string>",
      "name": "<string>",
      "code": "<string>"
    }
  ],
  "archivedClusters": [
    {
      "id": "<string>",
      "name": "<string>",
      "code": "<string>"
    }
  ]
}

Controls

Get v1controlsclusters

List clusters for a specified control, separated into active and archived groups.

Returns all clusters for the given control ID, partitioned into active (non-obsolete) and archived (obsolete) clusters. Both groups are sorted by name ascending.

Authentication: Required (X-API-Key header)

Query Parameters:

controlId - Required. The control ID (ULID format) to list clusters for

Response includes:

activeClusters - Array of active clusters
- id - Cluster unique identifier (ULID format)
- name - Cluster name
- code - Cluster code identifier
archivedClusters - Array of archived/obsolete clusters (same structure)

Use Cases:

View all clusters under a control with their current status
Identify which clusters are still active vs archived
Audit trail of all clusters for compliance purposes

GET

controls

clusters

cURL

curl --request GET \
  --url http://localhost/v1/controls/clusters \
  --header 'X-API-Key: <api-key>'

{
  "activeClusters": [
    {
      "id": "<string>",
      "name": "<string>",
      "code": "<string>"
    }
  ],
  "archivedClusters": [
    {
      "id": "<string>",
      "name": "<string>",
      "code": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

API Key provided by Eve Admin Portal. Include this header in all authenticated requests.

Query Parameters

controlId

string

required

Response

activeClusters

object[]

Show child attributes

archivedClusters

object[]

Show child attributes

Get v1controlsitems Get v1compliance reviews