Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Services

Create, read and update services. A service is addressed by its numeric counterId.

Creates a service

post

Creates a new service in a team. Learn more about services

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Header parameters
x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Body
namestringOptional
descstringOptional
Responses
200

Successful response

application/json
_idstringOptional
counterIdnumberOptional

Numeric id used in /services/{counterId} paths — not the _id.

namestringOptional
descstringOptional
teamsstring[]Optional
orgstringOptional
post/services/create
POST /services/create HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "name": "from api",
  "desc": "testing service create from api"
}
{
  "_id": "61d2c3b4a5968778695a4b3c",
  "counterId": 4,
  "name": "API",
  "desc": "Public REST API",
  "teams": [
    "5f2b1c4d9e8a7b6c5d4e3f21"
  ],
  "org": "5f72e289b17d1656e0115098"
}

Fetch all services

get

Get list of services for a team. Services are scopes for multiple integrations and their incidents. Learn more about services.

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Header parameters
x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

Successful response

application/json
totalServicesnumberOptional
get/services
GET /services HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*
{
  "totalServices": 1,
  "services": [
    {
      "_id": "61d2c3b4a5968778695a4b3c",
      "counterId": 4,
      "name": "API",
      "desc": "Public REST API",
      "teams": [
        "5f2b1c4d9e8a7b6c5d4e3f21"
      ],
      "org": "5f72e289b17d1656e0115098"
    }
  ],
  "pagination": {
    "perPage": 20,
    "currentPage": 1,
    "skip": 0,
    "total": 1,
    "totalPages": 1,
    "pages": [
      1
    ],
    "showingFrom": 0,
    "showingTill": 1
  }
}

Fetch incidents for a service

get

Get a list of incidents for a specific service. Returns a list of incidents for a service.

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Path parameters
counterIdstringRequired

counterId parameter

Header parameters
x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

Successful response

application/json
openIncidentsCountForServicenumberOptional
currentPagenumberOptional
perPagenumberOptional
totalnumberOptional
get/services/{counterId}/incidents
GET /services/{counterId}/incidents HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*
{
  "service": {
    "_id": "61d2c3b4a5968778695a4b3c",
    "counterId": 4,
    "name": "API",
    "desc": "Public REST API",
    "teams": [
      "5f2b1c4d9e8a7b6c5d4e3f21"
    ],
    "org": "5f72e289b17d1656e0115098"
  },
  "incidents": [
    {
      "_id": "65a1f4c8e9b2d3a4f5c6b7a8",
      "counterId": "eng-116",
      "message": "High CPU on api-prod-3",
      "status": "NACK",
      "priority": "p1",
      "severity": "sev1",
      "counter": 116,
      "org": "5f72e289b17d1656e0115098",
      "teams": [
        "5f2b1c4d9e8a7b6c5d4e3f21"
      ],
      "integration": {
        "_id": "62a1b2c3d4e5f60718293a4b",
        "name": "AWS CloudWatch",
        "token": "a1b2c3d4e5f6a7b8c9d0"
      },
      "service": {
        "_id": "61d2c3b4a5968778695a4b3c",
        "name": "API",
        "counterId": 4
      },
      "escalation": {
        "_id": "63c9a1b2d4e5f60718293a4b",
        "name": "Engineering primary"
      },
      "responders": [],
      "createdAt": "2026-03-13T09:41:00.000Z",
      "NACK_at": "2026-03-13T09:41:00.000Z"
    }
  ],
  "openIncidentsCountForService": 3,
  "currentPage": 1,
  "perPage": 20,
  "total": 116
}

Fetch integrations of a service

get

Get a list of integrations for a specific service. Includes all the integrations for a service with their details and webhook.

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Path parameters
counterIdstringRequired

counterId parameter

Header parameters
x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

Successful response

application/json
openIncidentsCountForServicenumberOptional
get/services/{counterId}/integrations
GET /services/{counterId}/integrations HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*
{
  "integrations": [
    {
      "_id": "62a1b2c3d4e5f60718293a4b",
      "name": "AWS CloudWatch",
      "slug": "aws",
      "token": "a1b2c3d4e5f6a7b8c9d0",
      "webhookUrl": "https://hooks.spike.sh/a1b2c3d4e5f6a7b8c9d0/push-events",
      "service": "61d2c3b4a5968778695a4b3c",
      "escalation": "63c9a1b2d4e5f60718293a4b",
      "teams": [
        "5f2b1c4d9e8a7b6c5d4e3f21"
      ],
      "createdAt": "2026-03-13T09:41:00.000Z"
    }
  ],
  "service": {
    "_id": "61d2c3b4a5968778695a4b3c",
    "counterId": 4,
    "name": "API",
    "desc": "Public REST API",
    "teams": [
      "5f2b1c4d9e8a7b6c5d4e3f21"
    ],
    "org": "5f72e289b17d1656e0115098"
  },
  "openIncidentsCountForService": 3
}

Fetch service details with incidents

get

Get details of a service with it's incidents. Services are scopes for multiple integrations and their incidents. This route also returns the list of incidents for a service.

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Path parameters
counterIdstringRequired

counterId parameter

Header parameters
x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

Successful response

application/json
orgobjectOptional
openIncidentsCountForServicenumberOptional
badgeURLstringOptional
get/services/{counterId}
GET /services/{counterId} HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*
{
  "service": {
    "_id": "61d2c3b4a5968778695a4b3c",
    "counterId": 4,
    "name": "API",
    "desc": "Public REST API",
    "teams": [
      "5f2b1c4d9e8a7b6c5d4e3f21"
    ],
    "org": "5f72e289b17d1656e0115098"
  },
  "org": {
    "_id": "5f72e289b17d1656e0115098",
    "name": "Acme Corp",
    "uid": "acme"
  },
  "openIncidentsCountForService": 3,
  "incidents": [
    {
      "_id": "65a1f4c8e9b2d3a4f5c6b7a8",
      "counterId": "eng-116",
      "message": "High CPU on api-prod-3",
      "status": "NACK",
      "priority": "p1",
      "severity": "sev1",
      "counter": 116,
      "org": "5f72e289b17d1656e0115098",
      "teams": [
        "5f2b1c4d9e8a7b6c5d4e3f21"
      ],
      "integration": {
        "_id": "62a1b2c3d4e5f60718293a4b",
        "name": "AWS CloudWatch",
        "token": "a1b2c3d4e5f6a7b8c9d0"
      },
      "service": {
        "_id": "61d2c3b4a5968778695a4b3c",
        "name": "API",
        "counterId": 4
      },
      "escalation": {
        "_id": "63c9a1b2d4e5f60718293a4b",
        "name": "Engineering primary"
      },
      "responders": [],
      "createdAt": "2026-03-13T09:41:00.000Z",
      "NACK_at": "2026-03-13T09:41:00.000Z"
    }
  ],
  "badgeURL": "https://api.spike.sh/services/4/badge.svg"
}

Fetch currently affected services

get
Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Header parameters
x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Responses
200

Successful response

application/json
get/services/affected
GET /services/affected HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*
{
  "affectedServices": [
    {
      "_id": "61d2c3b4a5968778695a4b3c",
      "counterId": 4,
      "name": "API",
      "desc": "Public REST API",
      "teams": [
        "5f2b1c4d9e8a7b6c5d4e3f21"
      ],
      "org": "5f72e289b17d1656e0115098"
    }
  ]
}

Updates a service

put

Update your service name and description only

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

x-team-idstringRequired

The target team's _id — a 24-character hex ObjectId such as 5f2b1c4d9e8a7b6c5d4e3f21. This is NOT the short uid slug (e.g. eng) shown in dashboard URLs; passing the uid will not resolve a team. Read the _id from GET /teams/get-all-teams or GET /teams/get-my-teams.

REQUIRED for: GET /on-calls (API-key callers get 400 without it), POST /on-calls, and every team-scoped read that declares it — the /incidents/* and /services/* listings, /escalations, /automation/rules and the integration endpoints.

OPTIONAL for: the incident action endpoints (acknowledge, resolve, escalate, unacknowledge), which derive the organisation from the API key itself; PUT /on-calls/{oncallId} and the on-call layer endpoints, which fall back to the organisation's default team; and org-wide reads such as GET /orgs/info and GET /users, which ignore it.

When supplied it must name a team inside the API key's organisation. A team from another organisation is rejected with 403.

Path parameters
counterIdstringRequired

counterId parameter

Header parameters
x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

The team's _id — a 24-character hex ObjectId, NOT the short uid slug. Read it from GET /teams/get-all-teams.

Example: 5f2b1c4d9e8a7b6c5d4e3f21
Body
namestringOptional
descstringOptional
Responses
200

The updated service. The path takes the numeric counterId, never the _id.

application/json
_idstringOptional
counterIdnumberOptional

Numeric id used in /services/{counterId} paths — not the _id.

namestringOptional
descstringOptional
teamsstring[]Optional
orgstringOptional
put/services/{counterId}/update
PUT /services/{counterId}/update HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "name": "updated from api",
  "desc": "some desc"
}
{
  "_id": "61d2c3b4a5968778695a4b3c",
  "counterId": 4,
  "name": "Public API",
  "desc": "Public REST API",
  "teams": [
    "5f2b1c4d9e8a7b6c5d4e3f21"
  ],
  "org": "5f72e289b17d1656e0115098"
}

Last updated