Trigger Documentation Deployment
Deploys a new generated version of documentation with guides & linked APIs
object
required
target
enum
required
Allowed Values:
Preview
Production
doc_version_id
string (uuid)
Responses
New deployment triggered
application/json
object
created_at
string (date-time)
required
current_preview
boolean
required
current_prod
boolean
required
doc_version
object
required
id
string
required
metadata
any_object
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
Code Examples
Response