Platform.sh API Documentation

Introduction
- Using the REST API
Authentication
- OAuth2
HAL Links
- _links Objects
- _embedded Objects
Project Administration
- Project
  - Project Overview
  - getGet a project
  - patchUpdate a project
  - delDelete a project
  - getGet a project's capabilities
  - postClear project build cache
- Domain Management
  - getGet list of project domains
  - postAdd a project domain
  - getGet a project domain
  - patchUpdate a project domain
  - delDelete a project domain
  - getGet a list of environment domains
  - postAdd an environment domain
  - getGet an environment domain
  - patchUpdate an environment domain
  - delDelete an environment domain
- Cert Management
  - getGet list of SSL certificates
  - postAdd an SSL certificate
  - getGet an SSL certificate
  - patchUpdate an SSL certificate
  - delDelete an SSL certificate
- Project Variables
  - getGet list of project variables
  - postAdd a project variable
  - getGet a project variable
  - patchUpdate a project variable
  - delDelete a project variable
- Repository
  - getGet a blob object
  - getGet a commit object
  - getGet list of repository refs
  - getGet a ref object
  - getGet a tree object
- Third-Party Integrations
  - getGet list of existing integrations for a project
  - postIntegrate project with a third-party service
  - getGet information about an existing third-party integration
  - patchUpdate an existing third-party integration
  - delDelete an existing third-party integration
- Support
  - postCreate a new support ticket
  - patchMark a support ticket as solved
  - getList support ticket priorities
  - getList support ticket categories
Environments
- Environment
  - getGet list of project environments
  - postCreate a new environment
  - getGet an environment
  - patchUpdate an environment
  - delDelete an environment
  - postActivate an environment
  - postBranch an environment
  - postDeactivate an environment
  - postInitialize a new environment
  - postMerge an environment
  - postRedeploy an environment
  - postSynchronize a child environment with its parent
- Environment Backups
  - postCreate snapshot of environment
  - getGet an environment's snapshot list
  - getGet an environment snapshot's info
  - delDelete an environment snapshot
  - postRestore an environment snapshot
- Environment Variables
  - getGet list of environment variables
  - postAdd an environment variable
  - getGet an environment variable
  - patchUpdate an environment variable
  - delDelete an environment variable
- Routing
  - getGet list of routes
  - postCreate a new route
  - getGet a route's info
  - patchUpdate a route
  - delDelete a route
- Source Operations
  - post[ALPHA] Trigger a source operation
  - getList source operations
- Deployment
  - getGet an environment's deployment information
  - getGet a single environment deployment
User Activity
- Project Activity
  - getGet project activity log
  - getGet a project activity log entry
  - postCancel a project activity
- Environment Activity
  - getGet environment activity log
  - getGet an environment activity log entry
  - postCancel an environment activity
Access Control
- Project Access
  - getGet a project's access control list
  - postAdd a user to a project ACL
  - getGet a single project ACL entry
  - patchUpdate a project user's role
  - delRemove a user from a project
- Environment Type
  - getGet environment types
  - getGet environment type links
- Environment Type Access
  - getGet an environment type's access control list
  - postAdd a user to an environment ACL
  - getGet a single environment type's ACL entry
  - patchUpdate an environment type user's role
  - delRemove a user from an environment type
- Environment Access
  - getGet an environment's access control list
  - postAdd a user to an environment ACL
  - getGet a single environment ACL entry
  - patchUpdate an environment user's role
  - delRemove a user from an environment
- Invitations
  - postInvite user to an organization by e-mail
  - getList pending invitations to an organization
  - delCancel a pending invitation to an organization
  - postInvite user to a project by e-mail
  - getList pending invitations to a project
  - delCancel a pending invitation to a project
Account Management
- Organizations
  - getUser organizations
  - getList organizations
  - postCreate organization
  - getGet organization
  - patchUpdate organization
  - delDelete organization
  - getList organization members.
  - postCreate organization member
  - getGet organization member
  - patchUpdate organization member
  - delDelete organization member
- API Tokens
  - getList a user's API tokens
  - postCreate an API token
  - getGet an API token
  - delDelete an API token
- Connections
  - getList federated login connections
  - getGet a federated login connection
  - delDelete a federated login connection
- MFA
  - getGet information about TOTP enrollment
  - postConfirm TOTP enrollment
  - delWithdraw TOTP enrollment
  - postRe-create recovery codes
- Users
  - getGet current logged-in user info
  - getGet the current user
  - getGet a user by email
  - getGet a user by username
  - getGet a user
  - patchUpdate a user
  - postReset email address
  - postReset user password
- User Profiles
  - getList user profiles
  - getGet a single user profile
  - patchUpdate a user profile
  - getGet a user address
  - patchUpdate a user address
  - postCreate a user profile picture
  - delDelete a user profile picture
- SSH Keys
  - getGet an SSH key
  - delDelete an SSH key
  - postAdd a new public SSH key to a user
- Plans
  - getList available plans
- References
  - getList referenced users
  - getList referenced organizations