Admin
Instance administration for people listed in ONESEND_ADMIN_EMAILS: status page incidents and self-checks.
List status page incidents
GET /v1/admin/status-incidents
Instance admins only (ONESEND_ADMIN_EMAILS).
Authentication: Authorization: Bearer with an API key or a session token.
Responses
{
"data": [{
"id": string,
"title": string,
"status": "investigating" | "identified" | "monitoring" | "resolved",
"impact": "minor" | "major" | "critical",
"components": [string],
"updates": [{ … }],
"createdAt": string,
"updatedAt": string,
"resolvedAt": string or null
}]
}Errors: 400, 401, 403, 404, 429, 500
400Invalid request: validation failed, a parameter is not allowed, the body is not valid JSON (invalid_json) or the pagination cursor is not valid (invalid_cursor). Typeinvalid_request.401Missing credentials (unauthorized), an unknown or revoked API key (invalid_api_key) or an expired session (invalid_session). Typeunauthorized.403The API key's permission does not allow this operation (insufficient_scope; configuration needs anadminkey), a test key was used outside its sandbox (test_key_not_allowed), a Conversion tracking key was used (publishable_key), or a cookie request is missingX-OneSend-Client: dashboard(csrf_header_required). Typeforbidden.404The resource does not exist in this workspace (not_found)429Too many requests; retry after the time in theRetry-Afterheader (rate_limited)500Unexpected server error (internal)
Post a status page incident
POST /v1/admin/status-incidents
Instance admins only. Shown on /status while open, and under past incidents for 90 days after it is resolved. An open incident sets its components to degraded (minor impact) or down (major, critical).
Authentication: Authorization: Bearer with an API key or a session token.
Request body
| Field | Type | Description |
|---|---|---|
titlerequired | string | |
bodyrequired | string | First update shown under the title |
status | "investigating" | "identified" | "monitoring" | "resolved" | Default "investigating". |
impact | "minor" | "major" | "critical" | Default "minor". |
components | array of "api" | "sending" | "inbound" | "dashboard" | Affected components (api, sending, inbound, dashboard); empty means all Default []. At most 10 items. |
Responses
{
"id": string,
"title": string,
"status": "investigating" | "identified" | "monitoring" | "resolved",
"impact": "minor" | "major" | "critical",
"components": [string],
"updates": [{
"at": string,
"status": string,
"body": string
}],
"createdAt": string,
"updatedAt": string,
"resolvedAt": string or null
}Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500
400Invalid request: validation failed, a parameter is not allowed, the body is not valid JSON (invalid_json) or the pagination cursor is not valid (invalid_cursor). Typeinvalid_request.401Missing credentials (unauthorized), an unknown or revoked API key (invalid_api_key) or an expired session (invalid_session). Typeunauthorized.403The API key's permission does not allow this operation (insufficient_scope; configuration needs anadminkey), a test key was used outside its sandbox (test_key_not_allowed), a Conversion tracking key was used (publishable_key), or a cookie request is missingX-OneSend-Client: dashboard(csrf_header_required). Typeforbidden.404The resource does not exist in this workspace (not_found)409The request conflicts with the current state, for example a duplicate name or a reusedIdempotency-Key(conflict)413The request body is larger than the limit for this endpoint (payload_too_large)415The body is not sent asContent-Type: application/json(unsupported_media_type)429Too many requests; retry after the time in theRetry-Afterheader (rate_limited)500Unexpected server error (internal)
Update a status page incident
PATCH /v1/admin/status-incidents/{id}
Instance admins only. Send body to add an update. Setting status: "resolved" closes the incident.
Authentication: Authorization: Bearer with an API key or a session token.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body
| Field | Type | Description |
|---|---|---|
title | string | |
status | "investigating" | "identified" | "monitoring" | "resolved" | |
impact | "minor" | "major" | "critical" | |
components | array of "api" | "sending" | "inbound" | "dashboard" | At most 10 items. |
body | string | Adds an update with this text (and the new or current status) |
Responses
{
"id": string,
"title": string,
"status": "investigating" | "identified" | "monitoring" | "resolved",
"impact": "minor" | "major" | "critical",
"components": [string],
"updates": [{
"at": string,
"status": string,
"body": string
}],
"createdAt": string,
"updatedAt": string,
"resolvedAt": string or null
}Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500
400Invalid request: validation failed, a parameter is not allowed, the body is not valid JSON (invalid_json) or the pagination cursor is not valid (invalid_cursor). Typeinvalid_request.401Missing credentials (unauthorized), an unknown or revoked API key (invalid_api_key) or an expired session (invalid_session). Typeunauthorized.403The API key's permission does not allow this operation (insufficient_scope; configuration needs anadminkey), a test key was used outside its sandbox (test_key_not_allowed), a Conversion tracking key was used (publishable_key), or a cookie request is missingX-OneSend-Client: dashboard(csrf_header_required). Typeforbidden.404The resource does not exist in this workspace (not_found)409The request conflicts with the current state, for example a duplicate name or a reusedIdempotency-Key(conflict)413The request body is larger than the limit for this endpoint (payload_too_large)415The body is not sent asContent-Type: application/json(unsupported_media_type)429Too many requests; retry after the time in theRetry-Afterheader (rate_limited)500Unexpected server error (internal)
Delete a status page incident
DELETE /v1/admin/status-incidents/{id}
Authentication: Authorization: Bearer with an API key or a session token.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
Errors: 400, 401, 403, 404, 409, 429, 500
400Invalid request: validation failed, a parameter is not allowed, the body is not valid JSON (invalid_json) or the pagination cursor is not valid (invalid_cursor). Typeinvalid_request.401Missing credentials (unauthorized), an unknown or revoked API key (invalid_api_key) or an expired session (invalid_session). Typeunauthorized.403The API key's permission does not allow this operation (insufficient_scope; configuration needs anadminkey), a test key was used outside its sandbox (test_key_not_allowed), a Conversion tracking key was used (publishable_key), or a cookie request is missingX-OneSend-Client: dashboard(csrf_header_required). Typeforbidden.404The resource does not exist in this workspace (not_found)409The request conflicts with the current state, for example a duplicate name or a reusedIdempotency-Key(conflict)429Too many requests; retry after the time in theRetry-Afterheader (rate_limited)500Unexpected server error (internal)
Run the status self-checks now
POST /v1/admin/status-checks/run
Instance admins only. Records one round of checks (as the 5-minute job does) and returns the results.
Authentication: Authorization: Bearer with an API key or a session token.
Responses
{
"data": [{
"component": string,
"status": string,
"detail": string
}]
}Errors: 400, 401, 403, 404, 409, 429, 500
400Invalid request: validation failed, a parameter is not allowed, the body is not valid JSON (invalid_json) or the pagination cursor is not valid (invalid_cursor). Typeinvalid_request.401Missing credentials (unauthorized), an unknown or revoked API key (invalid_api_key) or an expired session (invalid_session). Typeunauthorized.403The API key's permission does not allow this operation (insufficient_scope; configuration needs anadminkey), a test key was used outside its sandbox (test_key_not_allowed), a Conversion tracking key was used (publishable_key), or a cookie request is missingX-OneSend-Client: dashboard(csrf_header_required). Typeforbidden.404The resource does not exist in this workspace (not_found)409The request conflicts with the current state, for example a duplicate name or a reusedIdempotency-Key(conflict)429Too many requests; retry after the time in theRetry-Afterheader (rate_limited)500Unexpected server error (internal)