Sign Up

Preview

GET
/preview/{sandboxId}/public

Authorization

headerAuthorizationBearer <token>

API Key access

Path Parameters

sandboxId*string

ID of the sandbox

Response Body

Public status of the sandbox

response?booleanapplication/json
curl -X GET 'http://localhost:3000/preview/string/public'
true
GET
/preview/{sandboxId}/preview-warning

Authorization

headerAuthorizationBearer <token>

API Key access

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

Whether the preview warning page is enabled for the sandbox

application/json
  1. response
enabled*boolean

Whether the preview warning page is enabled for the sandbox

curl -X GET 'http://localhost:3000/preview/string/preview-warning'
{  "enabled": true}
GET
/preview/{sandboxId}/validate/{authToken}

Authorization

headerAuthorizationBearer <token>

API Key access

Path Parameters

sandboxId*string

ID of the sandbox

authToken*string

Auth token of the sandbox

Response Body

Sandbox auth token validation status

response?booleanapplication/json
curl -X GET 'http://localhost:3000/preview/string/validate/string'
true
GET
/preview/{sandboxId}/signing-key

Authorization

headerAuthorizationBearer <token>

API Key access

Path Parameters

sandboxId*string

ID of the sandbox

Response Body

Signing key of the sandbox

response?stringapplication/json
curl -X GET 'http://localhost:3000/preview/string/signing-key'
"string"
GET
/preview/{sandboxId}/access

Authorization

headerAuthorizationBearer <token>

API Key access

Path Parameters

sandboxId*string

Response Body

User access status to the sandbox

response?booleanapplication/json
curl -X GET 'http://localhost:3000/preview/string/access'
true
GET
/preview/{signedPreviewToken}/{port}/sandbox-id

Authorization

headerAuthorizationBearer <token>

API Key access

Path Parameters

signedPreviewToken*string

Signed preview URL token

port*number

Port number to get sandbox ID from signed preview URL token

Response Body

Sandbox ID from signed preview URL token

response?stringapplication/json
curl -X GET 'http://localhost:3000/preview/string/0/sandbox-id'
"string"