Skip to content
Press.js Press.js Press.js Docs

Overview

API reference for Press.js Cloud.

Press.js Cloud API 0.1.0

Section titled “Press.js Cloud API 0.1.0”

Use your Press.js Cloud API key as a Bearer token when calling these endpoints.

Informations

  • License: Apache-2.0
  • OpenAPI version: 3.1.1

Operations

Section titled “ Operations ”
GET
/v1/deploys
POST
/v1/deploys
GET
/v1/deploys/{deployId}
DELETE
/v1/deploys/{deployId}
PATCH
/v1/deploys/{deployId}
GET
/v1/deploys/{deployId}/settings
PATCH
/v1/deploys/{deployId}/settings
GET
/v1/deploys/{deployId}/versions
GET
/v1/deploys/{deployId}/versions/{deployVersionId}
DELETE
/v1/deploys/{deployId}/versions/{deployVersionId}
POST
/v1/deploys/{deployId}/aliases/{alias}
GET
/v1/pdfs
GET
/v1/pdfs/{pdfId}
DELETE
/v1/pdfs/{pdfId}
POST
/v1/pdfs/{pdfId}/download
POST
/v1/pdfs/{pdfId}/preview
GET
/v1/pdfs/{pdfId}/permanent-links
POST
/v1/pdfs/{pdfId}/permanent-links
DELETE
/v1/pdfs/{pdfId}/permanent-links/{linkId}
GET
/v1/render-jobs
POST
/v1/render-jobs
GET
/v1/deploys/{deployId}/render-jobs
POST
/v1/deploys/{deployId}/render-jobs
GET
/v1/render-jobs/{jobId}
POST
/v1/render-jobs/{jobId}/cancel
POST
/v1/render-jobs/{jobId}/output-download
POST
/v1/render-jobs/{jobId}/output-preview
DELETE
/v1/render-jobs/{jobId}/output
POST
/v1/upload-sessions
POST
/v1/upload-sessions/{uploadSessionId}/missing-blobs
PUT
/v1/upload-sessions/{uploadSessionId}/blobs/{sha256}
POST
/v1/upload-sessions/{uploadSessionId}/commit
GET
/v1/usage

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth ”

Press.js Cloud API key token. Send the API key as Authorization: Bearer pcak_....

Security scheme type: http

Bearer format: pcak_*