Cloud

Resolve the caller's Cloud instance for the browser gateway

Changed on

Starts or wakes the caller's own OpenWork Cloud browser instance when needed and returns the collaborator token only to the trusted gateway.

get/v1/cloud/gateway/resolve

Request

  • Base URL: https://api.openworklabs.com
  • URL: https://api.openworklabs.com/v1/cloud/gateway/resolve
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Response

Cloud instance status returned successfully for the gateway.

status'provisioning' | 'waking' | 'ready' | 'failed' required
urlstring uri nullable required
clientTokenstring nullable required
hostTokenstring nullable required
expiresAtstring date-time nullable required

Changes

  • bb8ff73e4ad3Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security denApiKey was added to the API

  • fcbb34aa1702Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status