> For the complete documentation index, see [llms.txt](https://docs.spike.sh/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spike.sh/spike-api-docs/actions-on-incidents.md).

# Actions On Incidents

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

## Acknowledge incident

> \*\*Acknowledge\*\* one or more incidents. If any incident's integration has \[Acknowledge Timeout]\(<https://docs.spike.sh/incidents/acknowledge-timeout>) set, it will come into play. Accepts an array of incident counter ids (\*116, prim-122\*).

```json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Actions on Incidents","description":"Acknowledge, resolve, escalate, unacknowledge, prioritise, set severity on and reassign incidents. Every action takes an `ids` array."}],"servers":[{"url":"https://api.spike.sh","description":"API server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the `x-api-key` header."}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"},"success":{"type":"boolean","description":"Present on the endpoints whose handlers include it (for example the API-key filter and the public on-call routes). Always `false` on an error."},"valid_api":{"type":"boolean","description":"Present on `401`s produced by the session/API-key filter. `false` means the supplied `x-api-key` was not recognised."},"statusCode":{"type":"number","description":"Echo of the HTTP status, present on a few permission errors."}}}}},"paths":{"/incidents/acknowledge":{"post":{"operationId":"postIncidentsAcknowledge","summary":"Acknowledge incident","description":"**Acknowledge** one or more incidents. If any incident's integration has [Acknowledge Timeout](https://docs.spike.sh/incidents/acknowledge-timeout) set, it will come into play. Accepts an array of incident counter ids (*116, prim-122*).","tags":["Actions on Incidents"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ids"],"description":"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.\n\nScoping: `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 `_id`s are exempt, because an ObjectId is unguessable.","properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"incidents":{"type":"array","items":{"type":"object","properties":{"counterId":{"type":"string"},"id":{"type":"string"}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Either the API key is missing/revoked (`{ valid_api: false }`), or the body named incidents by `counterId` without an org-scoped principal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The supplied `x-team-id` names a team in another organisation.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}},"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"x-team-id","in":"header","required":false,"schema":{"type":"string"},"description":"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`."}]}}}}
```

## Resolve incident

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

```json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Actions on Incidents","description":"Acknowledge, resolve, escalate, unacknowledge, prioritise, set severity on and reassign incidents. Every action takes an `ids` array."}],"servers":[{"url":"https://api.spike.sh","description":"API server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the `x-api-key` header."}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"},"success":{"type":"boolean","description":"Present on the endpoints whose handlers include it (for example the API-key filter and the public on-call routes). Always `false` on an error."},"valid_api":{"type":"boolean","description":"Present on `401`s produced by the session/API-key filter. `false` means the supplied `x-api-key` was not recognised."},"statusCode":{"type":"number","description":"Echo of the HTTP status, present on a few permission errors."}}}}},"paths":{"/incidents/resolve":{"post":{"operationId":"postIncidentsResolve","summary":"Resolve incident","description":"**Resolves** one or more incidents. Accepts an array of incident counter ids (*116, prim-122*).","tags":["Actions on Incidents"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ids"],"description":"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.\n\nScoping: `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 `_id`s are exempt, because an ObjectId is unguessable.","properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"incidents":{"type":"array","items":{"type":"object","properties":{"counterId":{"type":"string"},"id":{"type":"string"}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Either the API key is missing/revoked (`{ valid_api: false }`), or the body named incidents by `counterId` without an org-scoped principal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The supplied `x-team-id` names a team in another organisation.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}},"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"x-team-id","in":"header","required":false,"schema":{"type":"string"},"description":"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`."}]}}}}
```

## Escalate incident

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

```json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Actions on Incidents","description":"Acknowledge, resolve, escalate, unacknowledge, prioritise, set severity on and reassign incidents. Every action takes an `ids` array."}],"servers":[{"url":"https://api.spike.sh","description":"API server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the `x-api-key` header."}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"},"success":{"type":"boolean","description":"Present on the endpoints whose handlers include it (for example the API-key filter and the public on-call routes). Always `false` on an error."},"valid_api":{"type":"boolean","description":"Present on `401`s produced by the session/API-key filter. `false` means the supplied `x-api-key` was not recognised."},"statusCode":{"type":"number","description":"Echo of the HTTP status, present on a few permission errors."}}}}},"paths":{"/incidents/escalate":{"post":{"operationId":"postIncidentsEscalate","summary":"Escalate incident","description":"**Escalates** one or more incidents. Accepts an array of incident counter ids (*116, prim-122*).","tags":["Actions on Incidents"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ids"],"description":"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.\n\nScoping: `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 `_id`s are exempt, because an ObjectId is unguessable.","properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"A per-incident result summary. `escalated` counts incidents moved to the next escalation step; `skipped` explains the ones that were not.","content":{"application/json":{"schema":{"type":"object","properties":{"escalated":{"type":"number"},"resolved":{"type":"number"},"skipped":{"type":"array","items":{"type":"object","properties":{"counterId":{"type":"string"},"id":{"type":"string"},"reason":{"type":"string"}}}},"errors":{"type":"array","items":{"type":"string"}},"errorMessages":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Either the API key is missing/revoked (`{ valid_api: false }`), or the body named incidents by `counterId` without an org-scoped principal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}},"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"x-team-id","in":"header","required":false,"schema":{"type":"string"},"description":"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`."}]}}}}
```

## Unacknowledge incident

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

```json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Actions on Incidents","description":"Acknowledge, resolve, escalate, unacknowledge, prioritise, set severity on and reassign incidents. Every action takes an `ids` array."}],"servers":[{"url":"https://api.spike.sh","description":"API server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the `x-api-key` header."}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"},"success":{"type":"boolean","description":"Present on the endpoints whose handlers include it (for example the API-key filter and the public on-call routes). Always `false` on an error."},"valid_api":{"type":"boolean","description":"Present on `401`s produced by the session/API-key filter. `false` means the supplied `x-api-key` was not recognised."},"statusCode":{"type":"number","description":"Echo of the HTTP status, present on a few permission errors."}}}}},"paths":{"/incidents/unacknowledge":{"post":{"operationId":"postIncidentsUnacknowledge","summary":"Unacknowledge incident","description":"**Unacknowledge** one or more incidents. Accepts an array of incident counter ids (*116, prim-122*).","tags":["Actions on Incidents"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ids"],"description":"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.\n\nScoping: `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 `_id`s are exempt, because an ObjectId is unguessable.","properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Always `{ unacknowledged: true }` — the affected incidents are not echoed back.","content":{"application/json":{"schema":{"type":"object","properties":{"unacknowledged":{"type":"boolean"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Either the API key is missing/revoked (`{ valid_api: false }`), or the body named incidents by `counterId` without an org-scoped principal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The supplied `x-team-id` names a team in another organisation.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}},"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"x-team-id","in":"header","required":false,"schema":{"type":"string"},"description":"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`."}]}}}}
```

## Set priority

> 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]\(<https://docs.spike.sh/incidents/priority-and-severity>)

```json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Actions on Incidents","description":"Acknowledge, resolve, escalate, unacknowledge, prioritise, set severity on and reassign incidents. Every action takes an `ids` array."}],"servers":[{"url":"https://api.spike.sh","description":"API server"}],"security":[{"ApiKeyAuth":[],"TeamIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the `x-api-key` header."}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"},"success":{"type":"boolean","description":"Present on the endpoints whose handlers include it (for example the API-key filter and the public on-call routes). Always `false` on an error."},"valid_api":{"type":"boolean","description":"Present on `401`s produced by the session/API-key filter. `false` means the supplied `x-api-key` was not recognised."},"statusCode":{"type":"number","description":"Echo of the HTTP status, present on a few permission errors."}}}}},"paths":{"/incidents/priority":{"post":{"operationId":"postIncidentsPriority","summary":"Set priority","description":"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](https://docs.spike.sh/incidents/priority-and-severity)","tags":["Actions on Incidents"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"string","enum":["p1","p2","p3","p4","p5"]},"ids":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"prioritySet":{"type":"boolean"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"x-team-id","in":"header","required":true,"schema":{"type":"string"},"description":"The team's `_id` — a 24-character hex ObjectId, NOT the short `uid` slug. Read it from `GET /teams/get-all-teams`."}]}}}}
```

## Set severity

> 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]\(<https://docs.spike.sh/incidents/priority-and-severity>)

```json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Actions on Incidents","description":"Acknowledge, resolve, escalate, unacknowledge, prioritise, set severity on and reassign incidents. Every action takes an `ids` array."}],"servers":[{"url":"https://api.spike.sh","description":"API server"}],"security":[{"ApiKeyAuth":[],"TeamIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the `x-api-key` header."}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"},"success":{"type":"boolean","description":"Present on the endpoints whose handlers include it (for example the API-key filter and the public on-call routes). Always `false` on an error."},"valid_api":{"type":"boolean","description":"Present on `401`s produced by the session/API-key filter. `false` means the supplied `x-api-key` was not recognised."},"statusCode":{"type":"number","description":"Echo of the HTTP status, present on a few permission errors."}}}}},"paths":{"/incidents/severity":{"post":{"operationId":"postIncidentsSeverity","summary":"Set severity","description":"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](https://docs.spike.sh/incidents/priority-and-severity)","tags":["Actions on Incidents"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"severity":{"type":"string","enum":["sev1","sev2","sev3"]},"ids":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"severitySet":{"type":"boolean"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"x-team-id","in":"header","required":true,"schema":{"type":"string"},"description":"The team's `_id` — a 24-character hex ObjectId, NOT the short `uid` slug. Read it from `GET /teams/get-all-teams`."}]}}}}
```

## Remove priority

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

```json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Actions on Incidents","description":"Acknowledge, resolve, escalate, unacknowledge, prioritise, set severity on and reassign incidents. Every action takes an `ids` array."}],"servers":[{"url":"https://api.spike.sh","description":"API server"}],"security":[{"ApiKeyAuth":[],"TeamIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the `x-api-key` header."}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"},"success":{"type":"boolean","description":"Present on the endpoints whose handlers include it (for example the API-key filter and the public on-call routes). Always `false` on an error."},"valid_api":{"type":"boolean","description":"Present on `401`s produced by the session/API-key filter. `false` means the supplied `x-api-key` was not recognised."},"statusCode":{"type":"number","description":"Echo of the HTTP status, present on a few permission errors."}}}}},"paths":{"/incidents/priority/remove":{"delete":{"operationId":"deleteIncidentsPriorityRemove","summary":"Remove priority","description":"**Removes Priority** to one or more incidents. Accepts an array of incident counter ids (*116, prim-122*).","tags":["Actions on Incidents"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"priorityRemoved":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"x-team-id","in":"header","required":true,"schema":{"type":"string"},"description":"The team's `_id` — a 24-character hex ObjectId, NOT the short `uid` slug. Read it from `GET /teams/get-all-teams`."}]}}}}
```

## Remove severity

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

```json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Actions on Incidents","description":"Acknowledge, resolve, escalate, unacknowledge, prioritise, set severity on and reassign incidents. Every action takes an `ids` array."}],"servers":[{"url":"https://api.spike.sh","description":"API server"}],"security":[{"ApiKeyAuth":[],"TeamIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the `x-api-key` header."}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"},"success":{"type":"boolean","description":"Present on the endpoints whose handlers include it (for example the API-key filter and the public on-call routes). Always `false` on an error."},"valid_api":{"type":"boolean","description":"Present on `401`s produced by the session/API-key filter. `false` means the supplied `x-api-key` was not recognised."},"statusCode":{"type":"number","description":"Echo of the HTTP status, present on a few permission errors."}}}}},"paths":{"/incidents/severity/remove":{"delete":{"operationId":"deleteIncidentsSeverityRemove","summary":"Remove severity","description":"**Removes Severity** to one or more incidents. Accepts an array of incident counter ids (*116, prim-122*).","tags":["Actions on Incidents"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"severityRemoved":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"x-team-id","in":"header","required":true,"schema":{"type":"string"},"description":"The team's `_id` — a 24-character hex ObjectId, NOT the short `uid` slug. Read it from `GET /teams/get-all-teams`."}]}}}}
```

## Enable/Disable public sharing

> Enable/Disable public sharing for an incident. If enabled, you will get the public url in response. Learn more about \[public sharing]\(<https://docs.spike.sh/incidents/sharing-incidents>)

```json
{"openapi":"3.1.0","info":{"title":"Spike API","version":"1.0.0"},"tags":[{"name":"Actions on Incidents","description":"Acknowledge, resolve, escalate, unacknowledge, prioritise, set severity on and reassign incidents. Every action takes an `ids` array."}],"servers":[{"url":"https://api.spike.sh","description":"API server"}],"security":[{"ApiKeyAuth":[],"TeamIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the `x-api-key` header."}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the problem"},"error":{"type":"string","description":"Error type or code"},"success":{"type":"boolean","description":"Present on the endpoints whose handlers include it (for example the API-key filter and the public on-call routes). Always `false` on an error."},"valid_api":{"type":"boolean","description":"Present on `401`s produced by the session/API-key filter. `false` means the supplied `x-api-key` was not recognised."},"statusCode":{"type":"number","description":"Echo of the HTTP status, present on a few permission errors."}}}}},"paths":{"/incidents/{counterId}/public-sharing":{"patch":{"operationId":"patchIncidentsByCounterIdPublicSharing","summary":"Enable/Disable public sharing","description":"Enable/Disable public sharing for an incident. If enabled, you will get the public url in response. Learn more about [public sharing](https://docs.spike.sh/incidents/sharing-incidents)","tags":["Actions on Incidents"],"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"Your API key. Find it in your Spike dashboard under Settings > API."},{"name":"x-team-id","in":"header","required":true,"schema":{"type":"string"},"description":"The team's `_id` — a 24-character hex ObjectId, NOT the short `uid` slug. Read it from `GET /teams/get-all-teams`."},{"name":"counterId","in":"path","required":true,"schema":{"type":"string"},"description":"counterId parameter"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"publicSharing":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","description":"`public_url` is present only when sharing was enabled.","properties":{"done":{"type":"boolean"},"public_sharing_enabled":{"type":"boolean"},"public_url":{"type":"string"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```