Search...
⌘K
Toggle theme
Login
Search...
⌘K
API
Documentation Projects
More
Update Documentation Project
Start here
Get in touch
Creating SDKs
Creating Documentation
Documentation Components
Managing APIs
Organizations
Roles & Permissions
API References
API Projects
GET
List API Projects
GET
Get API Project
GET
List API Versions
GET
Get API Version
GET
Get OpenAPI
GET
Get Spec Stats
POST
Create API Project
POST
Initialize API Project
POST
Create API Version
POST
Lint OpenAPI
PATCH
Update API Version
DELETE
Delete API Project
DELETE
Delete API Version
SDK Generation
GET
List SDKs
POST
Generate SDK
POST
Initialize SDK Configuration
POST
Sync SDK Configuration
POST
Update SDK
POST
Get SDK Documentation
Documentation Projects
GET
List Documentation Projects
GET
Get Documentation Project
GET
List Documentation Deployments
GET
Get Documentation Deployment
GET
List Doc Proj Preview Passwords
GET
Get Documentation Project Theme
GET
List Documentation Project Versions
GET
Get Documentation Project Version
GET
List Guides
GET
Get Guide
GET
Get Guide Content
POST
Create Documentation Project
POST
Trigger Documentation Deployment
POST
Create Preview Password
POST
Create Guide
POST
Reorder Guides
PUT
Update Documentation Project Theme
PATCH
Update Documentation Project
PATCH
Update Guide
DELETE
Delete Documentation Project
DELETE
Deletes Preview Password
DELETE
Delete Guide
API Links
GET
List API Links
GET
Get API Link
GET
List API Link Groups
POST
Create API Link
POST
Reorder API Links & Groups
POST
Create API Link Group
PATCH
Updates API Link
PATCH
Update API Link Group
DELETE
Delete API Link
DELETE
Delete API Link Group
Assets
GET
List Assets
POST
Upload Asset
PATCH
Update Asset
DELETE
Delete Asset
Users
GET
Get Current User
GET
Get API Key
POST
Invite User
Service Accounts
GET
List Service Accounts
GET
Get Service Account
POST
Create Service Account
DELETE
Delete Service Account
Roles
GET
List Roles
POST
Create New Role
DELETE
Delete Role
Organization
GET
Get Organization
GET
Get Organization Theme
POST
Create Organization
PUT
Update Organization Theme
Update Documentation Project
PATCH
/
doc_project
/
{doc_name}
Body
object
required
Hide 3 properties
logos
object
Show 3 properties
name
string
Example:
my-company-docs
settings
object
Show 2 properties
Responses
200
OK
Documentation Project updated
application/json
object
Hide 7 properties
created_at
string (date-time)
required
current_version
object
required
Show 5 properties
domains
object
required
Show 2 properties
id
string (uuid)
required
logos
object
required
Show 3 properties
name
string
required
settings
object
required
Show 2 properties
default
Code Examples
json
Production
Build Request
Response
200