Introduction
Using the REST API
Authentication
OAuth2
HAL Links
_links Objects
_embedded Objects
Project Administration
Project
Project Overview
get
Get a project
patch
Update a project
del
Delete a project
get
Get a project's capabilities
post
Clear project build cache
Domain Management
get
Get list of project domains
post
Add a project domain
get
Get a project domain
patch
Update a project domain
del
Delete a project domain
get
Get a list of environment domains
post
Add an environment domain
get
Get an environment domain
patch
Update an environment domain
del
Delete an environment domain
Cert Management
get
Get list of SSL certificates
post
Add an SSL certificate
get
Get an SSL certificate
patch
Update an SSL certificate
del
Delete an SSL certificate
Project Variables
get
Get list of project variables
post
Add a project variable
get
Get a project variable
patch
Update a project variable
del
Delete a project variable
Repository
get
Get a blob object
get
Get a commit object
get
Get list of repository refs
get
Get a ref object
get
Get a tree object
Third-Party Integrations
get
Get list of existing integrations for a project
post
Integrate project with a third-party service
get
Get information about an existing third-party integration
patch
Update an existing third-party integration
del
Delete an existing third-party integration
Support
post
Create a new support ticket
patch
Mark a support ticket as solved
get
List support ticket priorities
get
List support ticket categories
Environments
Environment
get
Get list of project environments
post
Create a new environment
get
Get an environment
patch
Update an environment
del
Delete an environment
post
Activate an environment
post
Branch an environment
post
Deactivate an environment
post
Initialize a new environment
post
Merge an environment
post
Redeploy an environment
post
Synchronize a child environment with its parent
Environment Backups
post
Create snapshot of environment
get
Get an environment's snapshot list
get
Get an environment snapshot's info
del
Delete an environment snapshot
post
Restore an environment snapshot
Environment Variables
get
Get list of environment variables
post
Add an environment variable
get
Get an environment variable
patch
Update an environment variable
del
Delete an environment variable
Routing
get
Get list of routes
post
Create a new route
get
Get a route's info
patch
Update a route
del
Delete a route
Source Operations
post
[ALPHA] Trigger a source operation
get
List source operations
Deployment
get
Get an environment's deployment information
get
Get a single environment deployment
User Activity
Project Activity
get
Get project activity log
get
Get a project activity log entry
post
Cancel a project activity
Environment Activity
get
Get environment activity log
get
Get an environment activity log entry
post
Cancel an environment activity
Access Control
Project Access
get
Get a project's access control list
post
Add a user to a project ACL
get
Get a single project ACL entry
patch
Update a project user's role
del
Remove a user from a project
Environment Type
get
Get environment types
get
Get environment type links
Environment Type Access
get
Get an environment type's access control list
post
Add a user to an environment ACL
get
Get a single environment type's ACL entry
patch
Update an environment type user's role
del
Remove a user from an environment type
Environment Access
get
Get an environment's access control list
post
Add a user to an environment ACL
get
Get a single environment ACL entry
patch
Update an environment user's role
del
Remove a user from an environment
Invitations
post
Invite user to an organization by e-mail
get
List pending invitations to an organization
del
Cancel a pending invitation to an organization
post
Invite user to a project by e-mail
get
List pending invitations to a project
del
Cancel a pending invitation to a project
Account Management
Organizations
get
User organizations
get
List organizations
post
Create organization
get
Get organization
patch
Update organization
del
Delete organization
get
List organization members.
post
Create organization member
get
Get organization member
patch
Update organization member
del
Delete organization member
API Tokens
get
List a user's API tokens
post
Create an API token
get
Get an API token
del
Delete an API token
Connections
get
List federated login connections
get
Get a federated login connection
del
Delete a federated login connection
MFA
get
Get information about TOTP enrollment
post
Confirm TOTP enrollment
del
Withdraw TOTP enrollment
post
Re-create recovery codes
Users
get
Get current logged-in user info
get
Get the current user
get
Get a user by email
get
Get a user by username
get
Get a user
patch
Update a user
post
Reset email address
post
Reset user password
User Profiles
get
List user profiles
get
Get a single user profile
patch
Update a user profile
get
Get a user address
patch
Update a user address
post
Create a user profile picture
del
Delete a user profile picture
SSH Keys
get
Get an SSH key
del
Delete an SSH key
post
Add a new public SSH key to a user
Plans
get
List available plans
References
get
List referenced users
get
List referenced organizations