API referenceEndpointsPreviews
previews.mint
RPC previews.mint · Scope data
AuthorizationBearer <token>
A Plane API key, pl_<env>_…. The key is the environment: everything it reads and writes is scoped to the environment it was minted in, and the two tenancy headers are ignored for one.
In: header
Header Parameters
x-plane-environment?string
The environment slug this request is about. Honoured only for a session cookie; ignored for an API key, whose environment is its identity.
x-plane-organization?string
The organization slug or id this request is about, resolved before the environment. Honoured only for a session cookie.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/previews/mint" \ -H "Content-Type: application/json" \ -d '{ "sessionId": "string", "port": 1 }'{ "preview": { "id": "string", "sessionId": "string", "sandboxId": "string", "port": 1, "url": "string", "path": "tunnel", "public": true, "identity": "string", "createdAt": "string", "expiresAt": "string", "revokedAt": "string" }, "token": "string", "signedUrl": "string"}