Skip to content
Open Console →

Services

5 endpoints under /api/v1/services.

GET /api/v1/services #

List the organization's services

The shared spine the Lookout products meet on. Shown to any org with at least one Lookout product enabled.

Responses

200 The org's services, with live monitor counts.
Response body
  • servicesService[]required
    Show fields
    • idstringrequired
    • namestringrequired
    • monitorsintegerrequired
    • createdAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 No Lookout product is enabled for this organization.
Response body
  • errorstringrequired
404 Unknown service.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
POST /api/v1/services #

Create a service

Request body

  • namestringrequired

Responses

201 The created service.
Response body
  • idstringrequired
  • namestringrequired
  • monitorsintegerrequired
  • createdAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 No Lookout product is enabled for this organization.
Response body
  • errorstringrequired
404 Unknown service.
Response body
  • errorstringrequired
409 A service with this name already exists.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
GET /api/v1/services/{id} #

One service — the aggregated spine view

The Service plus its monitors, alert sources, attached escalation policy, status pages, and current maintenance window.

Parameters

  • id path string required

Responses

200 The aggregated service detail.
Response body
  • idstringrequired
  • namestringrequired
  • createdAtstringrequired
  • monitorsServiceDetailMonitor[]required
    Show fields
    • idstringrequired
    • namestringrequired
    • kindstring · enumrequired

      httptcp

    • enabledbooleanrequired
    • statestring · enum

      pendingupdown

  • alertSourcesServiceDetailAlertSource[]required
    Show fields
    • idstringrequired
    • namestringrequired
    • lastEventAtstringrequired
  • escalationPolicyobjectrequired
    Show fields
    • idstringrequired
    • namestringrequired
  • statusPagesServiceDetailStatusPage[]required
    Show fields
    • idstringrequired
    • slugstringrequired
    • namestringrequired
  • maintenanceobjectrequired
    Show fields
    • idstringrequired
    • titlestringrequired
    • statestring · enumrequired

      upcomingactivepast

    • startsAtstringrequired
    • endsAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 No Lookout product is enabled for this organization.
Response body
  • errorstringrequired
404 Unknown service.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
PATCH /api/v1/services/{id} #

Rename a service

Parameters

  • id path string required

Request body

  • namestringrequired

Responses

200 The renamed service.
Response body
  • idstringrequired
  • namestringrequired
  • monitorsintegerrequired
  • createdAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 No Lookout product is enabled for this organization.
Response body
  • errorstringrequired
404 Unknown service.
Response body
  • errorstringrequired
409 A service with this name already exists.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
DELETE /api/v1/services/{id} #

Delete a service

Refused (409) while the service has any live dependent — monitors, alert sources, or status-page membership — with a message naming what blocks it. An attached escalation policy does not block (it dies with the service).

Parameters

  • id path string required

Responses

204 Deleted.
401 No valid session.
Response body
  • errorstringrequired
403 No Lookout product is enabled for this organization.
Response body
  • errorstringrequired
404 Unknown service.
Response body
  • errorstringrequired
409 The service still has a live dependent.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired