Platform.sh
Platform.sh is the container-based Platform-as-a-Service (PaaS) founded in 2010 and headquartered in Paris and San Francisco, best known for Git-driven deployments in which a single push plus a few YAML files provisions an entire cluster of applications and managed services (PostgreSQL, MySQL, Redis, RabbitMQ, OpenSearch and more) together with byte-for-byte preview environments cloned from production. The company rebranded to Upsun: platform.sh now redirects to upsun.com, the original Platform.sh product is documented as 'Upsun Fixed' at docs.upsun.com, and the public REST API - whose own OpenAPI description reads 'Upsun, formerly Platform.sh' - is still authenticated by the OAuth 2.0 authorization server at auth.api.platform.sh with regional gateways on platform.sh hosts. That API exposes 263 operations across projects, environments, backups, domains, certificates, variables, activities, organizations, teams, subscriptions and billing, returns RFC 9457 application/problem+json errors, and is accompanied by a first-party CLI, PHP/JavaScript API clients and language config readers published under the platformsh namespace.
Platform.sh publishes 60 APIs on the APIs.io network, including Add Ons API, Alerts API, API Tokens API, and 57 more. Tagged areas include Platform as a Service, Cloud Hosting, Application Hosting, Deployment, and DevOps.
The Platform.sh catalog on APIs.io includes 1 event-driven AsyncAPI specification.
Platform.sh’s developer surface includes documentation, API reference, getting-started guide, support, engineering blog, pricing, signup flow, and 34 more developer resources.
60 APIs
1 MCP Servers
Individual APIs this provider publishes, each with its own machine-readable definition.
The Add-ons API from Platform.sh — 1 operation(s) for add-ons.
The Alerts API from Platform.sh — 1 operation(s) for alerts.
The API Tokens API from Platform.sh — 2 operation(s) for api tokens.
Upsun provides native support for autoscaling, allowing your applications to automatically adjust based on resource usage. This ensures that your apps remain responsive under lo...
The Blackfire Monitoring API from Platform.sh — 4 operation(s) for blackfire monitoring.
The Blackfire Profiling API from Platform.sh — 6 operation(s) for blackfire profiling.
User-supplied SSL/TLS certificates can be managed using these endpoints. You can now list and modify certificate provisioners using the `/projects/{projectId}/provisioners` and ...
The Connections API from Platform.sh — 2 operation(s) for connections.
The Continuous Profiling API from Platform.sh — 4 operation(s) for continuous profiling.
The Deployment API from Platform.sh — 2 operation(s) for deployment.
Upsun is capable of deploying the production environments of projects in multiple topologies: both in clusters of containers, and as dedicated virtual machines. This is an inter...
The Diff API from Platform.sh — 1 operation(s) for diff.
The Discounts API from Platform.sh — 3 operation(s) for discounts.
These endpoints can be used to add, modify, or remove domain claims from a project. For more information on how domains function on Upsun, see the [Domains](https://docs.upsun.c...
These endpoints can be used to add, modify, or remove domains from a project. For more information on how domains function on Upsun, see the [Domains](https://docs.upsun.com/anc...
The Entrypoint API from Platform.sh — 1 operation(s) for entrypoint.
The Environment Activity API from Platform.sh — 3 operation(s) for environment activity.
On Upsun, an environment encompasses a single instance of your entire application stack, the services used by the application, the application's data storage, and the environmen...
A snapshot is a complete backup of an environment, including all the persistent data from all services running in an environment and all files present in mounted volumes. These ...
Environment Types is the way Upsun manages access. We currently have 3 environment types: * Development * Staging * Production Each environment type will contain a group of user...
These endpoints manipulate user-defined variables which are bound to a specific environment, as well as (optionally) the children of an environment. These variables can be made ...
The Grants API from Platform.sh — 2 operation(s) for grants.
The Http Traffic API from Platform.sh — 3 operation(s) for http traffic.
These endpoints can be used to retrieve invoices from our billing system. An invoice of type "invoice" is generated automatically every month, if the customer has active project...
Multi-Factor Authentication (MFA) requires the user to present two (or more) types of evidence (or factors) to prove their identity. For example, the evidence might be a passwor...
These endpoints can be used to retrieve order information from our billing system. Here you can view information about your bill for our services, include the billed amount and ...
The Organization Invitations API from Platform.sh — 2 operation(s) for organization invitations.
The Organization Management API from Platform.sh — 4 operation(s) for organization management.
The Organization Members API from Platform.sh — 2 operation(s) for organization members.
The Organization Projects API from Platform.sh — 4 operation(s) for organization projects.
The Organizations API from Platform.sh — 4 operation(s) for organizations.
The PhoneNumber API from Platform.sh — 2 operation(s) for phonenumber.
The Profiles API from Platform.sh — 2 operation(s) for profiles.
The Project Activity API from Platform.sh — 3 operation(s) for project activity.
## Project Overview On Upsun, a Project is backed by a single Git repository and encompasses your entire application stack, the services used by your application, the applicatio...
The Project Invitations API from Platform.sh — 2 operation(s) for project invitations.
These endpoints can be used to retrieve and manipulate project-level settings. Only the `initialize` property can be set by end users. It is used to initialize a project from an...
These endpoints manipulate user-defined variables which are bound to an entire project. These variables are accessible to all environments within a single project, and they can ...
The Projects API from Platform.sh — 1 operation(s) for projects.
These endpoints retrieve information about which plans were assigned to a particular project at which time.
The References API from Platform.sh — 5 operation(s) for references.
The Regions API from Platform.sh — 2 operation(s) for regions.
The Git repository backing projects hosted on Upsun can be accessed in a **read-only** manner through the `/projects/{projectId}/git/*` family of endpoints. With these endpoints...
The Resources API from Platform.sh — 3 operation(s) for resources.
These endpoints modify an environment's `routes:` section of the `.upsun/config.yaml` file. For routes to propagate to child environments, the child environments must be synchro...
The Runtime Operations API from Platform.sh — 1 operation(s) for runtime operations.
These endpoints interact with source code operations as defined in the `source.operations` key in a project's `.upsun/config.yaml` configuration. More information on source code...
The SSH Keys API from Platform.sh — 2 operation(s) for ssh keys.
Each project is represented by a subscription that holds the plan information. These endpoints can be used to go to a larger plan, add more storage, or subscribe to optional fea...
These endpoints can be used to retrieve information about support ticket priority and allow you to submit new ticket to the Upsun Support Team.
These endpoints can be used to retrieve low-level information and interact with the core component of Upsun infrastructure. This is an internal API that can only be used by priv...
These endpoints can be used to manage tasks, which are one-off commands that can be run in the context of an environment. Tasks are useful for running database migrations, execu...
The Team Access API from Platform.sh — 4 operation(s) for team access.
The Teams API from Platform.sh — 5 operation(s) for teams.
Upsun can easily integrate with many third-party services, including Git hosting services (GitHub, GitLab, and Bitbucket), health notification services (email, Slack, PagerDuty)...
The Tickets API from Platform.sh — 1 operation(s) for tickets.
The User Access API from Platform.sh — 4 operation(s) for user access.
The User Profiles API from Platform.sh — 4 operation(s) for user profiles.
The Users API from Platform.sh — 9 operation(s) for users.
These endpoints can be used to retrieve vouchers associated with a particular user as well as apply a voucher to a particular user.
Model Context Protocol servers that expose these APIs to AI agents.
Published pricing tiers and plan structures.
Documented rate limits and quota policies.
AsyncAPI definitions for this provider's event-driven and streaming APIs.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
OAuth scopes governing access to this provider's APIs.
aid: platform.sh
name: Platform.sh
description: 'Platform.sh is the container-based Platform-as-a-Service (PaaS) founded in 2010 and headquartered in Paris and
San Francisco, best known for Git-driven deployments in which a single push plus a few YAML files provisions an entire cluster
of applications and managed services (PostgreSQL, MySQL, Redis, RabbitMQ, OpenSearch and more) together with byte-for-byte
preview environments cloned from production. The company rebranded to Upsun: platform.sh now redirects to upsun.com, the
original Platform.sh product is documented as ''Upsun Fixed'' at docs.upsun.com, and the public REST API - whose own OpenAPI
description reads ''Upsun, formerly Platform.sh'' - is still authenticated by the OAuth 2.0 authorization server at auth.api.platform.sh
with regional gateways on platform.sh hosts. That API exposes 263 operations across projects, environments, backups, domains,
certificates, variables, activities, organizations, teams, subscriptions and billing, returns RFC 9457 application/problem+json
errors, and is accompanied by a first-party CLI, PHP/JavaScript API clients and language config readers published under
the platformsh namespace.'
deliveryModel:
model: saas
open_source: false
commercial: true
callable_host: false
label: Hosted service · you call their endpoint
confidence: medium
source:
- openapi
- pricing
generated: '2026-08-28'
method: derived
image: https://upsun.com/default_social.png
url: https://raw.githubusercontent.com/api-evangelist/platform.sh/refs/heads/main/apis.yml
x-type: company
x-source: harvest:secondary-market
x-successor-brand: upsun
x-successor-note: Platform.sh rebranded to Upsun. platform.sh 301s to upsun.com, docs.platform.sh 301s to fixed.docs.upsun.com
('Upsun Fixed'), and api.platform.sh 301s to developer.upsun.com/api. The API Evangelist network also carries all/upsun
for the successor brand; this profile and that one describe the same company and the same REST API and should be reconciled
by the network de-duplication pass.
specificationVersion: '0.20'
created: '2026-08-26'
modified: '2026-08-26'
tags:
- Platform as a Service
- Cloud Hosting
- Application Hosting
- Deployment
- DevOps
- Continuous Deployment
- Containers
- Managed Services
- Developer Tools
- Infrastructure
- Multicloud
- Web Hosting
apis:
- aid: platform.sh:platform.sh-add-ons-api
name: Platform.sh Add Ons API
description: The Add-ons API from Platform.sh — 1 operation(s) for add-ons.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Add-ons
properties:
- type: OpenAPI
url: openapi/platform.sh-add-ons-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-alerts-api
name: Platform.sh Alerts API
description: The Alerts API from Platform.sh — 1 operation(s) for alerts.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Alerts
properties:
- type: OpenAPI
url: openapi/platform.sh-alerts-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-api-tokens-api
name: Platform.sh API Tokens API
description: The API Tokens API from Platform.sh — 2 operation(s) for api tokens.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- API Tokens
properties:
- type: OpenAPI
url: openapi/platform.sh-api-tokens-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-autoscaling-api
name: Platform.sh Autoscaling API
description: 'Upsun provides native support for autoscaling, allowing your applications to automatically adjust based on
resource usage.
This ensures that your apps remain responsive under load while helping you optimize costs.
You can configure thresholds for metrics such as CPU, RAM, and request latency.
Resources will automatically scale to meet demand.
Each container profile assigned to an application or service provides a specific combination of CPU and RAM, which you
can select via the Upsun UI or CLI.
These endpoints manage autoscaling configurations that are tied to a
specific environment, and optionally to its child environments.
You can define scaling rules based on metrics like CPU, memory, or
request latency, and these rules will be applied at both build time
and runtime. For more information on configuring autoscaling for your
environments, see the [Autoscaling](https://docs.upsun.com/manage-resources/autoscaling.html) section
of the documentation.'
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Autoscaling
properties:
- type: OpenAPI
url: openapi/platform.sh-autoscaling-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-blackfire-monitoring-api
name: Platform.sh Blackfire Monitoring API
description: The Blackfire Monitoring API from Platform.sh — 4 operation(s) for blackfire monitoring.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Blackfire Monitoring
properties:
- type: OpenAPI
url: openapi/platform.sh-blackfire-monitoring-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-blackfire-profiling-api
name: Platform.sh Blackfire Profiling API
description: The Blackfire Profiling API from Platform.sh — 6 operation(s) for blackfire profiling.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Blackfire Profiling
properties:
- type: OpenAPI
url: openapi/platform.sh-blackfire-profiling-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-cert-management-api
name: Platform.sh Cert Management API
description: 'User-supplied SSL/TLS certificates can be managed using these
endpoints. You can now list and modify certificate provisioners
using the `/projects/{projectId}/provisioners` and
`/projects/{projectId}/provisioners/{certificateProvisionerDocumentId}`
endpoints. For more information, see our
[Third-party TLS certificate](https://docs.upsun.com/anchors/domains/custom/custom-certificates/)
documentation. These endpoints are not for managing certificates
that are automatically supplied by Upsun via Let''s Encrypt.'
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Cert Management
properties:
- type: OpenAPI
url: openapi/platform.sh-cert-management-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-connections-api
name: Platform.sh Connections API
description: The Connections API from Platform.sh — 2 operation(s) for connections.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Connections
properties:
- type: OpenAPI
url: openapi/platform.sh-connections-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-continuous-profiling-api
name: Platform.sh Continuous Profiling API
description: The Continuous Profiling API from Platform.sh — 4 operation(s) for continuous profiling.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Continuous Profiling
properties:
- type: OpenAPI
url: openapi/platform.sh-continuous-profiling-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-deployment-api
name: Platform.sh Deployment API
description: The Deployment API from Platform.sh — 2 operation(s) for deployment.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Deployment
properties:
- type: OpenAPI
url: openapi/platform.sh-deployment-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-deployment-target-api
name: Platform.sh Deployment Target API
description: 'Upsun is capable of deploying the production environments of
projects in multiple topologies: both in clusters of containers, and
as dedicated virtual machines. This is an internal API that can
only be used by privileged users.'
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Deployment Target
properties:
- type: OpenAPI
url: openapi/platform.sh-deployment-target-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-diff-api
name: Platform.sh Diff API
description: The Diff API from Platform.sh — 1 operation(s) for diff.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Diff
properties:
- type: OpenAPI
url: openapi/platform.sh-diff-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-discounts-api
name: Platform.sh Discounts API
description: The Discounts API from Platform.sh — 3 operation(s) for discounts.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Discounts
properties:
- type: OpenAPI
url: openapi/platform.sh-discounts-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-domain-claim-api
name: Platform.sh Domain Claim API
description: 'These endpoints can be used to add, modify, or remove domain claims from
a project. For more information on how domains function on
Upsun, see the [Domains](https://docs.upsun.com/anchors/domains/custom/)
section of our documentation.'
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Domain Claim
properties:
- type: OpenAPI
url: openapi/platform.sh-domain-claim-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-domain-management-api
name: Platform.sh Domain Management API
description: 'These endpoints can be used to add, modify, or remove domains from
a project. For more information on how domains function on
Upsun, see the [Domains](https://docs.upsun.com/anchors/domains/custom/)
section of our documentation.'
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Domain Management
properties:
- type: OpenAPI
url: openapi/platform.sh-domain-management-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-entrypoint-api
name: Platform.sh Entrypoint API
description: The Entrypoint API from Platform.sh — 1 operation(s) for entrypoint.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Entrypoint
properties:
- type: OpenAPI
url: openapi/platform.sh-entrypoint-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-environment-activity-api
name: Platform.sh Environment Activity API
description: The Environment Activity API from Platform.sh — 3 operation(s) for environment activity.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Environment Activity
properties:
- type: OpenAPI
url: openapi/platform.sh-environment-activity-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-environment-api
name: Platform.sh Environment API
description: 'On Upsun, an environment encompasses a single instance of your
entire application stack, the services used by the application,
the application''s data storage, and the environment''s backups.
In general, an environment represents a single branch or merge request
in the Git repository backing a project. It is a virtual cluster
of read-only application and service containers with read-write
mounts for application and service data.
On Upsun, the default branch is your production environment—thus,
merging changes to this branch will put those changes to production.'
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Environment
properties:
- type: OpenAPI
url: openapi/platform.sh-environment-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-environment-backups-api
name: Platform.sh Environment Backups API
description: 'A snapshot is a complete backup of an environment, including all the
persistent data from all services running in an environment and all
files present in mounted volumes.
These endpoints can be used to trigger the creation of new backups,
get information about existing backups, delete existing backups or
restore a backup.
More information about backups can be found in our
[documentation](https://docs.upsun.com/anchors/environments/backup/).'
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Environment Backups
properties:
- type: OpenAPI
url: openapi/platform.sh-environment-backups-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-environment-type-api
name: Platform.sh Environment Type API
description: 'Environment Types is the way Upsun manages access. We currently have 3 environment types:
* Development
* Staging
* Production
Each environment type will contain a group of users and their accesses. We manage access,
adding, updating and removing users and their roles, here.
Each environment will have a type, pointing to one of these 3 environment types.
See `type` in [Environments](#tag/Environment).
In general:
* Production will be reserved for the default branch, and cannot be set manually.
* An environment can be set to be type `staging` or development manually and when branching.
Dedicated Generation 2 projects have different rules for environment types. If your project
contains at least one of those Dedicated Generation 2 environments, the rules are slightly different:
* All non-dedicated environments in your project can be `development` or `staging`, but never `production`.
* Dedicated Generation 2 environments can be set either to `staging` or `production`, but never `development`.
* The default branch is not considered to be a special case.'
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Environment Type
properties:
- type: OpenAPI
url: openapi/platform.sh-environment-type-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-environment-variables-api
name: Platform.sh Environment Variables API
description: 'These endpoints manipulate user-defined variables which are bound to a
specific environment, as well as (optionally) the children of an
environment. These variables can be made available at both build time
and runtime. For more information on environment variables,
see the [Variables](https://docs.upsun.com/anchors/variables/set/environment/create/)
section of the documentation.'
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Environment Variables
properties:
- type: OpenAPI
url: openapi/platform.sh-environment-variables-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-grants-api
name: Platform.sh Grants API
description: The Grants API from Platform.sh — 2 operation(s) for grants.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Grants
properties:
- type: OpenAPI
url: openapi/platform.sh-grants-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-http-traffic-api
name: Platform.sh Http Traffic API
description: The Http Traffic API from Platform.sh — 3 operation(s) for http traffic.
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Http Traffic
properties:
- type: OpenAPI
url: openapi/platform.sh-http-traffic-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-invoices-api
name: Platform.sh Invoices API
description: 'These endpoints can be used to retrieve invoices from our billing system.
An invoice of type "invoice" is generated automatically every month, if the customer has active projects.
Invoices of type "credit_memo" are a result of manual action when there was a refund or an invoice correction.'
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Invoices
properties:
- type: OpenAPI
url: openapi/platform.sh-invoices-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-mfa-api
name: Platform.sh MFA API
description: 'Multi-Factor Authentication (MFA) requires the user to present two (or more) types of evidence (or factors)
to prove their identity.
For example, the evidence might be a password and a device-generated code, which show the user has the knowledge factor
("something you know")
as well as the possession factor ("something you have"). In this way MFA offers good protection against the compromise
of any single factor,
such as a stolen password.
Using the MFA API you can set up time-based one-time passcodes (TOTP), which can be generated on a single registered device
("something you have") such as a mobile phone.'
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- MFA
properties:
- type: OpenAPI
url: openapi/platform.sh-mfa-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platform.sh-conventions.yml
- type: DataModel
url: data-model/platform.sh-data-model.yml
- type: RateLimits
url: rate-limits/platform.sh-rate-limits.yml
- type: Documentation
url: https://developer.upsun.com/api
- type: ToolCrosswalk
url: mcp/platform.sh-tool-crosswalk.yml
- type: Webhooks
url: asyncapi/platform.sh-webhooks.yml
- aid: platform.sh:platform.sh-orders-api
name: Platform.sh Orders API
description: 'These endpoints can be used to retrieve order information from our billing
system. Here you can view information about your bill for our services,
include the billed amount and a link to a PDF of the bill.'
humanURL: https://developer.upsun.com/api
baseURL: https://api.upsun.com
tags:
- Orders
properties:
- type: OpenAPI
url: openapi/platform.sh-orders-api-openapi.yml
- type: Authentication
url: authentication/platform.sh-authentication.yml
- type: OAuthScopes
url: scopes/platform.sh-scopes.yml
- type: ErrorCatalog
url: errors/platform.sh-problem-types.yml
- type: Conventions
url: conventions/platfor
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/platform.sh/refs/heads/main/apis.yml
Every provider here is available over the APIs.io API and to AI agents over MCP.