Get operation
Get a long-running operation
/api/v2/operations/{operation}Authentication WLT-Api-Key
Poll by the operation's short ID. Treat done as the terminal signal and check for either response or error. Read the guide.
Path parameters
operationstringrequiredQuery parameters
waitbooleanBlock for the operation to finish before returning, up to the server wait cap.
falseResponses
200
Successful Response
application/json
An operation with its result, available through singular reads.
idstringrequiredShort operation id used in /operations/{operation} paths.
ownerIdstringrequiredAccount that owns the operation.
metadataobject | nullTask information and optional progress details. Use metadata.task to interpret a generic operation response, and use done to determine completion.
donebooleanrequiredWhether the operation is terminal. When true, a non-null error indicates failure; otherwise the operation succeeded.
errorOperationError | nullFailure details when done is true and the task failed; null while running and after success.
expiresAtSecsinteger | nullTask execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
createdAtSecsinteger | nullUnix seconds when the operation was accepted.
responseobject | nullTask-specific result when done is true and the task succeeded; null while running and after failure.
namestringrequiredFull resource name for the operation.
For project operations:
accounts/{account}/projects/{project}/operations/{operation}.
Operation paths accept the short id.
422
Validation Error
application/json
detailarray<ValidationError>