api-docs-icon

Trigger Documentation Deployment

POST
/ doc_project/ {doc_name}/ deployment

Deploys a new generated version of documentation with guides & linked APIs











Response
















doc_name
string
required

Unique project name or the uuid

Example:
my-project

target
enum
required
Allowed Values:
Preview
Production
doc_version_id
string<uuid>

Responses

New deployment triggered

created_at
string<date-time>
required
current_preview
boolean
required
current_prod
boolean
required
doc_version
object
required

id
string
required
metadata
map<string, any>
required

an object describing the guides, api links, and theming included in the triggered deployment

status
enum
required
Allowed Values:
Building
Cancelled
Complete
Created
Error
Generated
target
enum
required
Allowed Values:
Preview
Production