Platform.sh API Documentation

Introduction
- Using the REST API
Authentication
- OAuth2
HAL Links
- _links Objects
- _embedded Objects
Project Administration
- Project
  - Project Overview
  - postClear project build cache
  - delDelete a project
  - patchUpdate a project's info
  - getGet a project's info
  - getGet a project's capabilities
- Domain Management
  - postAdd a project domain
  - getGet list of project domains
  - delDelete a project domain
  - patchUpdate a project domain
  - getGet a project domain
- Cert Management
  - postAdd an SSL certificate
  - getGet list of SSL certificates
  - delDelete an SSL certificate
  - patchUpdate an SSL certificate
  - getGet an SSL certificate
- Project Variables
  - delDelete a project variable
  - patchUpdate a project variable
  - getGet a project variable
  - postAdd a project variable
  - getGet list of project variables
- Repository
  - getGet a blob object
  - getGet a commit object
  - getGet a tree object
  - getGet list of repository refs
  - getGet a ref object
- Third-Party Integrations
  - postIntegrate project with a third-party service
  - getGet list of existing integrations for a project
  - delDelete an existing third-party integration
  - patchUpdate an existing third-party integration
  - getGet information about existing an third-party integration
- Support
  - getPlatform.sh support ticket comment
  - postCreate a new Platform.sh support ticket comment
  - getDescription is the first comment of a ticket
  - getA complete list of attachments for a ticket
  - getPlatform.sh support tickets
  - postCreate a new Platform.sh support ticket
  - getReturn a list of available priorities for a license
Environments
- Environment
  - postActivate an environment
  - delDelete an environment
  - patchUpdate an environment
  - getGet an environment
  - postRedeploy an environment
  - postBranch an environment
  - postSynchronize a child environment with its parent
  - postDeactivate an environment
  - postInitialize a new environment
  - postMerge an environment
  - postCreate a new environment
  - getGet list of project environments
- Environment Backups
  - postCreate snapshot of environment
  - postRestore an environment snapshot
  - delDelete an environment snapshot
  - getGet an environment snapshot's info
  - getGet an environment's snapshot list
- Environment Variables
  - delDelete an environment variable
  - patchUpdate an environment variable
  - getGet an environment variable
  - postAdd an environment variable
  - getGet list of environment variables
- Routing
  - delDelete a route
  - patchUpdate a route
  - getGet a route's info
  - postCreate a new route
  - getGet list of routes
- Source Operations
  - post[ALPHA] Trigger a source operation
- Deployment
  - getGet an environment's deployment information
User Activity
- Project Activity
  - getGet project activity log
  - getGet a project activity log entry
- Environment Activity
  - getGet environment activity log
  - getGet an environment activity log entry
Access Control
- Project Access
  - postAdd a user to a project ACL
  - getGet a project's access control list
  - delRemove a user from a project
  - patchUpdate a project user's role
  - getGet a single project ACL entry
- Environment Access
  - delRemove a user from an environment
  - patchUpdate an environment user's role
  - getGet a single environment ACL entry
  - postAdd a user to an environment ACL
  - getGet an environment's access control list
- Invitation
  - postInvite user by e-mail
Account Management
- Users
  - getGet current logged-in user info
  - getGet list of a user's SSH keys
  - getGet a single user
  - getSearch for users
  - postRegister a new user
- User Profiles
  - getGet user profiles
  - getGet a single user profile
  - patchUpdate a user profile
  - getGet a user address
  - patchUpdate a user address
  - postCreate a users profile picture
  - delDelete a users profile picture
- SSH Keys
  - getGet a single SSH key record
  - delDelete a single SSH key
  - postAdd a new public SSH key to a user
- Subscriptions
  - getSearch for subscriptions
  - postStart a new subscription
  - getGet information about a single subscription
  - delDelete a subscription
  - patchUpdate a subscription
  - postEstimate existing subscription price
  - postEstimate new subscription price
- Plans
  - getGet available plans
Billing
- Orders
  - getGet list of orders
  - getGet an order
- Vouchers
  - getGet list of vouchers associated with a user
  - postApply a voucher to a user
- Records
  - getRetrieve project plan records
  - getRetrieve project usage records
Global Info
- Project Discovery
  - getLocate user projects
  - getGet information about a single project
- Regions
  - getGet list of available regions
  - getGet information about a single region
Internal APIs
- Project Settings
  - patchUpdate a project setting
  - getGet list of project settings
- Deployment Target
  - postCreate a project deployment target
  - getGet project deployment target info
  - delDelete a single project deployment target
  - patchUpdate a project deployment
  - getGet a single project deployment target
- System Information
  - getGet information about the Git server.
  - postRestart the Git server

Documentation Powered by ReDoc