Preview
GET
/preview/{sandboxId}/publicAuthorizationBearer <token>
API Key access
In: header
Path Parameters
sandboxId*string
ID of the sandbox
Response Body
application/json
curl -X GET "https://example.com/preview/string/public"trueGET
/preview/{sandboxId}/preview-warningAuthorizationBearer <token>
API Key access
In: header
Path Parameters
sandboxId*string
ID of the sandbox, or a signed preview URL token (requires the port query param)
Query Parameters
port?number
Port the signed preview URL token was issued for. Required when sandboxId is a signed token.
Response Body
application/json
curl -X GET "https://example.com/preview/string/preview-warning"{ "enabled": true}GET
/preview/{sandboxId}/validate/{authToken}AuthorizationBearer <token>
API Key access
In: header
Path Parameters
sandboxId*string
ID of the sandbox
authToken*string
Auth token of the sandbox
Response Body
application/json
curl -X GET "https://example.com/preview/string/validate/string"trueGET
/preview/{sandboxId}/signing-keyAuthorizationBearer <token>
API Key access
In: header
Path Parameters
sandboxId*string
ID of the sandbox
Response Body
application/json
curl -X GET "https://example.com/preview/string/signing-key""string"GET
/preview/{sandboxId}/accessAuthorizationBearer <token>
API Key access
In: header
Path Parameters
sandboxId*string
Response Body
application/json
curl -X GET "https://example.com/preview/string/access"trueGET
/preview/{signedPreviewToken}/{port}/sandbox-idAuthorizationBearer <token>
API Key access
In: header
Path Parameters
signedPreviewToken*string
Signed preview URL token
port*number
Port number to get sandbox ID from signed preview URL token
Response Body
application/json
curl -X GET "https://example.com/preview/string/0/sandbox-id""string"