ReferenceAdmin
Turn maintenance mode on or off, or change its reason and planned end (platform admins with a session; audited)
PUT
/v1/admin/settings/maintenanceOn pauses new ingestion everywhere (see GET /v1/maintenance) and needs a reason, shown to users. The planned end is informational: maintenance mode ends only when an admin turns it off, and parked work then resumes by itself. Every process sees a change within a few seconds. Audited as platform.maintenance_start, platform.maintenance_update or platform.maintenance_end.
Header Parameters
If-Match*string
The resource's revision, as returned in ETag (for example "3"). Missing returns 428; stale returns 412.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/admin/settings/maintenance" \ -H "If-Match: string" \ -H "Content-Type: application/json" \ -d '{ "enabled": true }'{ "data": { "enabled": true, "reason": "string", "plannedEndAt": "2019-08-24T14:15:22Z", "startedAt": "2019-08-24T14:15:22Z", "startedBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "displayName": "string", "email": "string" }, "updatedBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "displayName": "string", "email": "string" }, "updatedAt": "2019-08-24T14:15:22Z", "revision": 0 }}