v1

latestOpenAPI 3.1.02026-07-17254060.5 KB
changes and tasks

Wait for a change to complete

Wait for the change to be finished.

If the wait operation succeeds, the result will have the "err" field set to an appropriate error message if the change itself had an error.

get/v1/changes/{id}/wait

Path parameters

idstring required

The ID of the change to wait for.

Query parameters

timeoutstring

Optional timeout (a duration). If specified, wait till the change is ready or a timeout occurs, whichever is first. If not specified or zero, wait indefinitely until the change is ready.

Response

Wait for a change.

typestring

Response type, "sync".

status-codeinteger

HTTP response status code.

statusstring

The description of the HTTP status code.

See the IANA list.