Actions On Incidents

Acknowledge, resolve, escalate, unacknowledge, prioritise, set severity on and reassign incidents. Every action takes an ids array.

Acknowledge incident

post

Acknowledge one or more incidents. If any incident's integration has Acknowledge Timeout set, it will come into play. Accepts an array of incident counter ids (116, prim-122).

Authorizations

ApiKeyAuth

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.

Header parameters

x-api-keystringRequired

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

x-team-idstringOptional

Optional here. The organisation is derived from the API key, not from this header, so incident actions work without it. When supplied it must be a team _id belonging to the key's organisation, otherwise the request is rejected with 403.

Example: 5f2b1c4d9e8a7b6c5d4e3f21

Body

application/json

An ARRAY of incident ids. Each entry may be a counterId (e.g. eng-116) or an incident _id. Also answers on /incidents/acknowledge/multi with an identical handler.

Scoping: counterId entries are only accepted when the request is scoped to an organisation — send a valid x-api-key (the org is taken from the key) or call with a dashboard session. An unscoped counterId request is rejected with 401. Entries that are _ids are exempt, because an ObjectId is unguessable.

idsstring[]RequiredExample: ["eng-116"]

Responses

200

Successful response

application/json

successbooleanOptional

400

Bad request

application/json

401

Either the API key is missing/revoked ({ valid_api: false }), or the body named incidents by counterId without an org-scoped principal.

application/json

403

The supplied x-team-id names a team in another organisation.

application/json

post/incidents/acknowledge

HTTPcURLJavaScriptPython

POST /incidents/acknowledge HTTP/1.1
Host: api.spike.sh
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "ids": [
    "eng-116"
  ]
}

{
  "success": true,
  "incidents": [
    {
      "counterId": "eng-116",
      "id": "65a1f4c8e9b2d3a4f5c6b7a8"
    }
  ]
}

Resolve incident

post

Resolves one or more incidents. Accepts an array of incident counter ids (116, prim-122).

Authorizations

ApiKeyAuth

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.

Header parameters

x-api-keystringRequired

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

x-team-idstringOptional

Optional here. The organisation is derived from the API key, not from this header, so incident actions work without it. When supplied it must be a team _id belonging to the key's organisation, otherwise the request is rejected with 403.

Example: 5f2b1c4d9e8a7b6c5d4e3f21

Body

application/json

An ARRAY of incident ids. Each entry may be a counterId (e.g. eng-116) or an incident _id. Also answers on /incidents/resolve/multi with an identical handler.

Scoping: counterId entries are only accepted when the request is scoped to an organisation — send a valid x-api-key (the org is taken from the key) or call with a dashboard session. An unscoped counterId request is rejected with 401. Entries that are _ids are exempt, because an ObjectId is unguessable.

idsstring[]RequiredExample: ["eng-116"]

Responses

200

Successful response

application/json

successbooleanOptional

400

Bad request

application/json

401

Either the API key is missing/revoked ({ valid_api: false }), or the body named incidents by counterId without an org-scoped principal.

application/json

403

The supplied x-team-id names a team in another organisation.

application/json

post/incidents/resolve

HTTPcURLJavaScriptPython

POST /incidents/resolve HTTP/1.1
Host: api.spike.sh
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "ids": [
    "eng-116"
  ]
}

{
  "success": true,
  "incidents": [
    {
      "counterId": "eng-116",
      "id": "65a1f4c8e9b2d3a4f5c6b7a8"
    }
  ]
}

Escalate incident

post

Escalates one or more incidents. Accepts an array of incident counter ids (116, prim-122).

Authorizations

ApiKeyAuth

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.

Header parameters

x-api-keystringRequired

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

x-team-idstringOptional

Optional here. The organisation is derived from the API key, not from this header, so incident actions work without it. When supplied it must be a team _id belonging to the key's organisation, otherwise the request is rejected with 403.

Example: 5f2b1c4d9e8a7b6c5d4e3f21

Body

application/json

An ARRAY of incident ids. Each entry may be a counterId (e.g. eng-116) or an incident _id. Also answers on /incidents/escalate/multi with an identical handler.

Scoping: counterId entries are only accepted when the request is scoped to an organisation — send a valid x-api-key (the org is taken from the key) or call with a dashboard session. An unscoped counterId request is rejected with 401. Entries that are _ids are exempt, because an ObjectId is unguessable.

idsstring[]RequiredExample: ["eng-116"]

Responses

200

A per-incident result summary. escalated counts incidents moved to the next escalation step; skipped explains the ones that were not.

application/json

escalatednumberOptional

resolvednumberOptional

errorsstring[]Optional

errorMessagesstring[]Optional

400

Bad request

application/json

401

Either the API key is missing/revoked ({ valid_api: false }), or the body named incidents by counterId without an org-scoped principal.

application/json

403

Either the supplied x-team-id names a team in another organisation ({ success: false, message: "x-team-id does not belong to this organisation" }), or nothing was escalated and at least one incident was skipped — in which case message is the first skip reason.

application/json

post/incidents/escalate

HTTPcURLJavaScriptPython

POST /incidents/escalate HTTP/1.1
Host: api.spike.sh
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "ids": [
    "eng-116"
  ]
}

{
  "escalated": 1,
  "resolved": 0,
  "skipped": [
    {
      "counterId": "eng-115",
      "id": "65a1f4c8e9b2d3a4f5c6b7a9",
      "reason": "Incident is already resolved"
    }
  ],
  "errors": [],
  "errorMessages": []
}

Unacknowledge incident

post

Unacknowledge one or more incidents. Accepts an array of incident counter ids (116, prim-122).

Authorizations

ApiKeyAuth

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.

Header parameters

x-api-keystringRequired

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

x-team-idstringOptional

Optional here. The organisation is derived from the API key, not from this header, so incident actions work without it. When supplied it must be a team _id belonging to the key's organisation, otherwise the request is rejected with 403.

Example: 5f2b1c4d9e8a7b6c5d4e3f21

Body

application/json

An ARRAY of incident ids. Each entry may be a counterId (e.g. eng-116) or an incident _id. Also answers on /incidents/unacknowledge/multi with an identical handler.

Scoping: counterId entries are only accepted when the request is scoped to an organisation — send a valid x-api-key (the org is taken from the key) or call with a dashboard session. An unscoped counterId request is rejected with 401. Entries that are _ids are exempt, because an ObjectId is unguessable.

idsstring[]RequiredExample: ["eng-116"]

Responses

200

Always { unacknowledged: true } — the affected incidents are not echoed back.

application/json

unacknowledgedbooleanOptional

400

Bad request

application/json

401

Either the API key is missing/revoked ({ valid_api: false }), or the body named incidents by counterId without an org-scoped principal.

application/json

403

The supplied x-team-id names a team in another organisation.

application/json

post/incidents/unacknowledge

HTTPcURLJavaScriptPython

POST /incidents/unacknowledge HTTP/1.1
Host: api.spike.sh
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "ids": [
    "eng-116"
  ]
}

{
  "unacknowledged": true
}

Set priority

post

Adds Priority to one or more incidents. Accepts an array of incident counter ids (116, prim-122). Priority can belong to one of p1, p2, p3, p4, p5 values. Learn more about priority

Authorizations

ApiKeyAuth & TeamIdHeader

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

application/json

prioritystring · enumOptionalPossible values:

idsstring[]Optional

Responses

200

Successful response

application/json

prioritySetbooleanOptional

400

Bad request

application/json

401

Unauthorized

application/json

post/incidents/priority

HTTPcURLJavaScriptPython

POST /incidents/priority HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "ids": [
    "eng-116"
  ],
  "priority": "p1"
}

{
  "prioritySet": true
}

Set severity

post

Adds Severity to one or more incidents. Accepts an array of incident counter ids (116, prim-122). Severity can belong to one of sev1, sev2, sev3 values. Learn more about severity

Authorizations

ApiKeyAuth & TeamIdHeader

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

application/json

severitystring · enumOptionalPossible values:

idsstring[]Optional

Responses

200

Successful response

application/json

severitySetbooleanOptional

400

Bad request

application/json

401

Unauthorized

application/json

post/incidents/severity

HTTPcURLJavaScriptPython

POST /incidents/severity HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "ids": [
    "eng-116"
  ],
  "severity": "sev1"
}

{
  "severitySet": true
}

Remove priority

delete

Removes Priority to one or more incidents. Accepts an array of incident counter ids (116, prim-122).

Authorizations

ApiKeyAuth & TeamIdHeader

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

application/json

idsstring[]Optional

Responses

200

Successful response

application/json

priorityRemovedbooleanOptional

401

Unauthorized

application/json

delete/incidents/priority/remove

HTTPcURLJavaScriptPython

DELETE /incidents/priority/remove HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "ids": [
    "eng-116"
  ]
}

{
  "priorityRemoved": true
}

Remove severity

delete

Removes Severity to one or more incidents. Accepts an array of incident counter ids (116, prim-122).

Authorizations

ApiKeyAuth & TeamIdHeader

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

application/json

idsstring[]Optional

Responses

200

Successful response

application/json

severityRemovedbooleanOptional

401

Unauthorized

application/json

delete/incidents/severity/remove

HTTPcURLJavaScriptPython

DELETE /incidents/severity/remove HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "ids": [
    "eng-116"
  ]
}

{
  "severityRemoved": true
}

Enable/Disable public sharing

patch

Enable/Disable public sharing for an incident. If enabled, you will get the public url in response. Learn more about public sharing

Authorizations

ApiKeyAuth & TeamIdHeader

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

application/json

publicSharingbooleanOptional

Responses

200

Successful response

application/json

public_url is present only when sharing was enabled.

donebooleanOptional

public_sharing_enabledbooleanOptional

public_urlstringOptional

400

Bad request

application/json

401

Unauthorized

application/json

404

Not found

application/json

patch/incidents/{counterId}/public-sharing

HTTPcURLJavaScriptPython

PATCH /incidents/{counterId}/public-sharing HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "publicSharing": true
}

{
  "done": true,
  "public_sharing_enabled": true,
  "public_url": "https://app.spike.sh/public/incidents/5f72e289b17d1656e0115098/eng-116"
}