How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Scalar publish API

The publish API from Scalar — 11 operation(s) for publish.

Scalar publish API is one of 30 APIs that Scalar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Publish. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 11 paths, and defines 9 schemas. It is described by OpenAPI 3.1.1, at version 1.0.1.

11 operations 11 paths 9 schemas 3 DELETE2 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
API Version
1.0.1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Scalar publish API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 3 DELETE, 2 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

publish 11
POST
/publish/dns-check
Validates the DNS records for a specified subdomain
postpublishDnsCheck body → 200400401403404422500
DELETE
/unpublish
Removes the active deploy from a project, without deleting cached assets
deleteunpublish body → 200400401403404422500
DELETE
/publish
Delete a publish record and its cached assets
deletepublish body → 200400401403404422500
POST
/pubsub/publish-deleted
Deletes a cached build from the GCP bucket
postpubsubPublishDeleted body → 200400401403404422500
POST
/publish/redeploy
Redeploy a previous publish
postpublishRedeploy body → 200400401403404422500
DELETE
/publish/bulk
Bulk delete all non-deployed publish records
deletepublishBulk body → 200400401403404422500
POST
/publish/cancel
Cancel an in-flight publish before it goes live
postpublishCancel body → 200400401403404422500
GET
/publish/logs/{publishUid}
Checks & creates a publish record for a CLI publish
getpublishLogsPublishUid 1 param → 200400401403404422500
POST
/publish/domains/availability
Checks availability for publish domain
postpublishDomainsAvailability body → 200400401403404422500
POST
/publish/domains/project
Returns active domains for a project
postpublishDomainsProject body → 200400401403404422500
GET
/publish/deploy-check
Verifies a specific site is deployed and SSL certificates can be issued for it.
getpublishDeployCheck 1 param → 200400401403404422500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are publish-record (16 properties), 404 (2 properties), 422 (2 properties), 403 (2 properties). Each schema is shown below with its type and property counts.

publish-record
object
16 properties 16 required
nanoid
string
404
object
2 properties 2 required
401
object
2 properties 2 required
500
object
2 properties 2 required
400
object
2 properties 2 required
403
object
2 properties 2 required
timestamp
integer
422
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scalar-publish-api-openapi.yml Raw ↑

Other APIs Scalar publishes across the network.

Scalar API References
Scalar API Client
Scalar Docs
Scalar Registry
Scalar SDKs
Scalar CLI
Scalar access-groups API
Scalar analytics API
Scalar api-docs API
Scalar auth API
Scalar docs API
Scalar Docs Projects API
Where this information came from

This is an independent, third-party profile of Scalar publish API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.