REST API

Services API

List Services

GET /api/v1/services

Query Parameters

Parameter Type Description
status string Filter by status: operational, degraded, down, maintenance
limit integer Results per page (default: 25, max: 100)
offset integer Number of results to skip

Example

curl https://app.alert24.io/api/v1/services \
  -H "Authorization: Bearer ak_live_YOUR_KEY"

Response

{
  "data": [
    {
      "id": "svc-123",
      "name": "API Gateway",
      "description": "Main API entry point",
      "status": "operational",
      "status_page_id": "sp-456",
      "sort_order": 0,
      "created_at": "2026-01-15T10:00:00.000Z",
      "updated_at": "2026-03-19T14:00:00.000Z"
    }
  ],
  "meta": { "total": 5, "limit": 25, "offset": 0, "has_more": false }
}

Get Service

GET /api/v1/services/:id

Create Service

POST /api/v1/services

Scope required: write

Request Body

Field Type Required Description
name string Yes Service name
description string No Service description
status string No Initial status (default: operational)
status_page_id string No Link to a status page
sort_order integer No Display order (default: 0)

Example

curl https://app.alert24.io/api/v1/services \
  -X POST \
  -H "Authorization: Bearer ak_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Payment Processing",
    "description": "Stripe integration and payment flow",
    "status": "operational"
  }'

Update Service

PUT /api/v1/services/:id

Scope required: write

Request Body

Field Type Description
name string Updated name
description string Updated description
status string Updated status
sort_order integer Updated display order

Example — Mark a service as degraded

curl https://app.alert24.io/api/v1/services/svc-123 \
  -X PUT \
  -H "Authorization: Bearer ak_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "degraded" }'

Delete Service

DELETE /api/v1/services/:id

Scope required: write

Soft-deletes the service. It will no longer appear in listings or on status pages.

curl https://app.alert24.io/api/v1/services/svc-123 \
  -X DELETE \
  -H "Authorization: Bearer ak_live_YOUR_KEY"
← Incidents APIMonitoring API →