ONoneuptime
DockerSwarm Cluster

Get DockerSwarm Cluster

Endpoint to retrieve a single DockerSwarm Cluster by ID

post/docker-swarm-cluster/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the DockerSwarm Cluster to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "otelCollectorStatus": true,
    "agentVersion": true,
    "swarmId": true,
    "aiRemediationMode": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "pve-production",
    "slug": "example-slug-value",
    "description": "Production Docker Swarm cluster running in US East region",
    "otelCollectorStatus": "connected",
    "agentVersion": "1.0.0",
    "dockerVersion": "27.3.1",
    "lastSeenAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "nodeCount": 42,
    "readyNodeCount": 42,
    "managerNodeCount": 42,
    "serviceCount": 42,
    "taskCount": 42,
    "runningTaskCount": 42,
    "stackCount": 42,
    "networkCount": 42,
    "swarmId": "abc123def456ghi789",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "isArchived": true,
    "archivedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "archivedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "retainTelemetryDataForDays": 42,
    "telemetryRetentionConfig": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "isAiInvestigationEnabled": true,
    "aiRemediationMode": "RequireApproval",
    "aiCommandAllowlist": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "aiAccessLastVerifiedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "aiAccessLastError": "This is an example of longer text content that might be stored in this field.",
    "aiAccessConfiguredAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.