Saltar al contenido
Centro de ayuda
Productos

Referencia de la API

GET /api/v1/public/incidents/{id}

Return incident by id

Returns a single incident, scoped to the API key's account. Same fields as Return incidents, as a single object with no pagination wrapper.

operationId Return incident by id

Parámetros de ruta

Nombre Tipo Obligatorio Descripción
id string (uuid) obligatorio Incident identifier.

Respuestas

200 The incident.

Encabezados de respuesta

NombreTipoDescripción
X-RateLimit-Limit integer Your hourly allowance.
X-RateLimit-Remaining integer Requests left in the current window.
X-RateLimit-Reset integer When the window resets, as an absolute Unix epoch time in seconds — not a countdown.

Cuerpo de application/json

Campo Tipo Obligatorio Descripción
error boolean obligatorio Always `false` on a successful response. Authentication and rate-limit failures instead return a string error code in this field.
data object obligatorio The incident object.
id string (uuid) obligatorio Incident identifier.
incident_number string obligatorio Human-readable reference, e.g. `INC-2026-0001`.
description string opcional Incident description.
status string obligatorio Workflow status, e.g. `open`.
severity_score integer opcional Calculated severity — `severity_likelihood` × `severity_impact`.
severity_likelihood integer opcional Likelihood rating.
severity_impact integer opcional Impact rating.
location string opcional Location name.
incident_date string (date) opcional Date the incident occurred.
created_at string (date-time) obligatorio When the incident was created.
updated_at string (date-time) obligatorio When the incident was last updated.

401 `API_KEY_REQUIRED` — the `Authorization: Bearer kcs_…` header is missing or malformed. `API_KEY_INVALID` — the key is unknown, revoked, or expired.

403 `INSUFFICIENT_SCOPE` — the key's scope does not permit this method. `FEATURE_NOT_AVAILABLE` — the account's plan does not include API access.

404 No incident with that id exists in the account — `{ "error": true, "message": "Incident not found" }`. Also returned when the incident belongs to a different account, so a caller cannot distinguish "absent" from "not yours".

429 `RATE_LIMIT_EXCEEDED` — the hourly limit was reached. Read `Retry-After` (seconds); `X-RateLimit-Reset` is not set on a 429.

Encabezados de respuesta

NombreTipoDescripción
Retry-After integer Seconds to wait before retrying.

500 Unexpected server error.