Activate Incident Management

POST /api/im/activate

Turns Incident Management on for your organization. Until this has run, every other endpoint of this API answers 403 with imNotEnabled; this one (and the setup state) is reachable before activation on purpose.

Activation is idempotent. On an organization that is already enabled it returns alreadyEnabled: true and changes nothing. On the first activation Uptimeify also runs its activation hooks, for example the backfill that brings open monitoring incidents into Incident Management when the monitoring bridge is on. A hook that fails does not undo the activation; its name is listed in hookErrors.

AuthenticationCopy Anchor Link

Requires an IM-eligible role and write access to the organization: the admin role of that organization, or an organization-wide API token created by an organization admin. editor and responder receive 403 (forbidden).

Query parametersCopy Anchor Link

Example (cURL)Copy Anchor Link

curl -X POST "$BASE_URL/api/im/activate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

ResponseCopy Anchor Link

First activation:

{
  "organizationId": 42,
  "enabled": true,
  "monitoringBridge": true,
  "alreadyEnabled": false,
  "hookErrors": []
}

Already enabled:

{
  "organizationId": 42,
  "enabled": true,
  "monitoringBridge": true,
  "alreadyEnabled": true
}

Common errorsCopy Anchor Link

• 400 Bad Request (organizationIdRequired) when no organization can be determined
• 401 Unauthorized when not authenticated
• 403 Forbidden (customerScopedTokenForbidden) when using a customer-scoped token
• 403 Forbidden (imAccessDenied) when the caller has no IM-eligible role
• 403 Forbidden (forbidden) when the caller is not an admin of the organization