Start maintenance mode

edit

Start maintenance mode

edit

Starts maintenance mode on the allocator.

Request

edit

POST /api/v1/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_start

Path parameters

edit

Name	Type	Required	Description
`allocator_id`	`string`	Y	The allocator identifier.

Query parameters

edit

Name	Type	Required	Description
`reason`	`string`	N	Provides a reason for changing the maintenance mode which will appear as a message on the allocator.

Responses

edit

202

(EmptyResponse)

The start maintenance mode command was issued successfully

403

(BasicFailedReply)

The start maintenance mode command was prohibited for the given allocator. (code: root.unauthorized.rbac)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac]): The error codes associated with the response

404

(BasicFailedReply)

The allocator specified by {allocator_id} cannot be found. (code: allocators.allocator_not_found)

Headers

x-cloud-error-codes (string; allowed values: [allocators.allocator_not_found]): The error codes associated with the response

Request example

edit

curl -XPOST https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_start \
-H "Authorization: ApiKey $ECE_API_KEY"

« Set allocator logging settings Stop maintenance mode »