api-docs-icon

Get Documentation Deployment

GET
/ doc_project/ {doc_name}/ deployment/ {deployment_id}

Retrieves single deployment

Responses

Retrieved deployment

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