Sign in

v2

latestOpenAPI 3.0.0SolarWinds Software Services Agreement2026-07-2167105153.0 KB
entities

Get an entity by ID

get/v1/entities/{id}

Path parameters

idstring required

The entity's ID

Response

The request has succeeded.

idstring required

The ID of the entity.

typestring required

The type of the entity.

namestring

The name of the entity.

displayNamestring nullable

Entity display name / alias. This value is equal to name unless it is explicitly overridden.

createdTimestring date-time

Date and time of entity creation in UTC.

updatedTimestring date-time

Date and time of last entity update in UTC.

lastSeenTimestring date-time required

Date and time when the entity has last received telemetry in UTC.

inMaintenanceboolean required

Flag telling if given entity is in maintenance mode.

tagsobject required

Entity tags. Tag is a key-value pair, where there may be only a single tag value for the same key.

attributesobject

Map of available attributes.

Example response

{
  "id": "e-1234567890",
  "type": "SyslogHost",
  "name": "syslog-host-1",
  "displayName": "SyslogTest",
  "createdTime": "2024-11-25T16:38:24Z",
  "updatedTime": "2024-12-01T16:38:24Z",
  "lastSeenTime": "2024-11-25T16:38:24Z",
  "tags": {
    "gg.tk.token": "test",
    "kfi.tk.token": "qa-test"
  },
  "attributes": {
    "protocols": [
      "HTTP"
    ],
    "features": [
      "rum"
    ],
    "isAvailabilityCheckPaused": false,
    "extensions": {
      "has_extension": true
    }
  }
}