v2

latestOpenAPI 3.0.0SolarWinds Software Services Agreement2026-07-2167105153.0 KB

entities/websites

Get website

get/v1/entities/websites/{entityId}

Path parameters

entityIdstring required

Entity ID.

Response

The request has succeeded.

idstring required

Unique identifier of the website.

typestring required

Entity type, always 'Website'.

status'up' | 'down' | 'paused' | 'maintenance' | 'unknown' required

namestring required

Name of the website, which must be unique within the organization. The website must also not contain any control characters, any white space other than space (U+0020), or any consecutive, leading or trailing spaces.

urlstring required

URL of the website. Must be a valid URL with no leading or trailing white space. Must not contain invalid port number (>65535).

lastOutageStartTimestring date-time nullable

Time when the last outage started.

lastOutageEndTimestring date-time nullable

Time when the last outage ended.

lastTestTimestring date-time nullable

Time when the last test was performed.

lastErrorTimestring date-time nullable

Last time when a synthetic test failed.

lastResponseTimeinteger nullable

Response time from the last synthetic check in milliseconds.

nextOnDemandAvailabilityTimeinteger

Timestamp for when the next on-demand check could be executed. If at '0', it means you can execute it anytime.

Example response

{
  "id": "e-1448474379026206720",
  "type": "Website",
  "name": "solarwinds.com",
  "url": "https://www.solarwinds.com",
  "monitoringOptions": {
    "isAvailabilityActive": true
  },
  "availabilityCheckSettings": {
    "platformOptions": {
      "probePlatforms": [
        "AWS"
      ],
      "testFromAll": true
    },
    "testFrom": {
      "type": "REGION",
      "values": [
        "NA"
      ]
    },
    "outageConfiguration": {
      "consecutiveForDown": 2
    },
    "checkForString": {
      "value": "string"
    },
    "protocols": [
      "HTTP",
      "HTTPS"
    ],
    "ssl": {
      "enabled": true,
      "daysPriorToExpiration": 7,
      "ignoreIntermediateCertificates": true
    },
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "allowInsecureRenegotiation": true,
    "postData": "{\"example\": \"value\"}"
  },
  "tags": [
    {
      "key": "environment",
      "value": "production"
    }
  ],
  "rum": {
    "apdexTimeInSeconds": 4,
    "snippet": "string",
    "spa": true
  },
  "lastOutageStartTime": "2025-01-15T14:31:19.735Z",
  "lastOutageEndTime": "2025-01-15T14:31:19.735Z",
  "lastTestTime": "2025-01-15T14:31:19.735Z",
  "lastErrorTime": "2025-01-15T14:31:19.735Z",
  "lastResponseTime": 376
}