ONoneuptime
Probe

Get Probe

Endpoint to retrieve a single Probe by ID

post/probe/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Probe to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "key": true,
    "name": 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,
    "key": "Example short text",
    "name": "US East Coast Probe",
    "description": "Monitors services from the US East Coast region",
    "slug": "example-slug-value",
    "probeVersion": {
      "_type": "Version",
      "value": "1.0.0"
    },
    "lastAlive": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "iconFileId": "123e4567-e89b-12d3-a456-426614174000",
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "shouldAutoEnableProbeOnNewMonitors": true,
    "connectionStatus": "connected",
    "packetCaptureCapability": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ]
  }
}

Changes

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