ONoneuptime
Network Site

List Network Site

Endpoint to list all Network Site items

post/network-site/get-list

Request

Request body

limitnumber

Maximum number of items to return. Defaults to 10.

skipnumber

Number of items to skip for pagination. Defaults to 0.

Example request

{
  "query": {
    "createdAt": {
      "_type": "GreaterThan",
      "value": "2026-01-01T00:00:00.000Z"
    },
    "name": {
      "_type": "Search",
      "value": "example"
    }
  },
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "siteType": true,
    "address": true,
    "healthRollupPolicy": true
  },
  "sort": {
    "createdAt": "DESC"
  }
}

Response

Successful response

countnumber

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": "Unit 1042 - Springfield",
      "slug": "example-slug-value",
      "description": "All franchise units in the Springfield market",
      "siteType": "Unit",
      "networkSiteTypeId": "123e4567-e89b-12d3-a456-426614174000",
      "probeId": "123e4567-e89b-12d3-a456-426614174000",
      "snmpCredentialProfileId": "123e4567-e89b-12d3-a456-426614174000",
      "parentSiteId": "123e4567-e89b-12d3-a456-426614174000",
      "materializedPath": "/5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e/",
      "depth": 42,
      "address": "742 Evergreen Terrace, Springfield, IL",
      "latitude": 42,
      "longitude": 42,
      "currentMonitorStatusId": "123e4567-e89b-12d3-a456-426614174000",
      "lastRollupAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "healthRollupPolicy": "WorstStatus",
      "offlineThresholdPercent": 42,
      "shouldAlertWhenUnhealthy": true,
      "alertSeverityId": "123e4567-e89b-12d3-a456-426614174000",
      "currentActiveAlertId": "123e4567-e89b-12d3-a456-426614174000",
      "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
      "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

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