MethodPathDescription
POST/v1/bootstrap/validate/{action}Perform bootstrap validation

Bootstrap validation

POST /v1/bootstrap/validate/{action}

Perform bootstrap validation.

Unlike actual bootstrapping, this request blocks and immediately returns with a response.

Request

Example HTTP request

POST /bootstrap/validate/join_cluster

Request body

The request must contain a bootstrap configuration object, similar to the one used for actual bootstrapping.

Response

If an error occurs, the call returns a bootstrap_status JSON object that contains the following fields:

FieldDescription
stateCurrent bootstrap state.

idle: No bootstrapping started.

initiated: Bootstrap request received.

creating_cluster: In the process of creating a new cluster.

joining_cluster: In the process of joining an existing cluster.

error: The last bootstrap action failed.

completed: The last bootstrap action completed successfully.
start_timeBootstrap process start time
end_timeBootstrap process end time
error_codeIf state is error, this error code describes the type of error encountered.
error_detailsAn error-specific object that may contain additional information about the error. A common field in use is message which provides a more verbose error message.

Status codes

CodeDescription
200 OKNo error, validation was successful.
406 Not AcceptableValidation failed, bootstrap status is returned as body.