ONoneuptime
Runner

Get Runner

Endpoint to retrieve a single Runner by ID

post/runner/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Runner to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "key": true,
    "connectionStatus": 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": "prod-eu-west-1-agent",
    "description": "Runs in the production EU cluster; can reach internal services.",
    "slug": "example-slug-value",
    "key": "Example short text",
    "agentVersion": {
      "_type": "Version",
      "value": "1.0.0"
    },
    "lastAlive": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "connectionStatus": "connected",
    "canRunRunbooks": true,
    "canRunAiCommands": true,
    "takesCodeFixes": true,
    "isGlobalRunner": true,
    "isProjectDefault": true,
    "hostInfo": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ]
  }
}

Changes

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