> ## Documentation Index
> Fetch the complete documentation index at: https://developer.upsun.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get a project's capabilities
> Get a list of capabilities on a project, as defined by the billing system.
For instance, one special capability that could be defined on a project is
large development environments.
## OpenAPI
````yaml https://meta.upsun.com/openapi-spec get /projects/{projectId}/capabilities
openapi: 3.0.1
info:
title: Upsun.com Rest API
version: '1.0'
contact:
name: Support
url: https://upsun.com/contact-us/
termsOfService: https://upsun.com/trust-center/legal/tos/
description: >
# Introduction
Upsun, formerly Platform.sh, is a container-based Platform-as-a-Service. Our
main API
is simply Git. With a single `git push` and a couple of YAML files in
your repository you can deploy an arbitrarily complex cluster.
Every [**Project**](#tag/Project) can have multiple applications (PHP,
Node.js, Python, Ruby, Go, etc.) and managed, automatically
provisioned services (databases, message queues, etc.).
Each project also comes with multiple concurrent
live staging/development [**Environments**](#tag/Environment).
These ephemeral development environments
are automatically created every time you push a new branch or create a
pull request, and each has a full copy of the data of its parent branch,
which is created on-the-fly in seconds.
Our Git implementation supports integrations with third party Git
providers such as GitHub, Bitbucket, or GitLab, allowing you to simply
integrate Upsun into your existing workflow.
## Using the REST API
In addition to the Git API, we also offer a REST API that allows you to
manage
every aspect of the platform, from managing projects and environments,
to accessing accounts and subscriptions, to creating robust workflows
and integrations with your CI systems and internal services.
These API docs are generated from a standard **OpenAPI (Swagger)**
Specification document
which you can find here in [YAML](openapispec-upsun.yaml) and in
[JSON](openapispec-upsun.json) formats.
This RESTful API consumes and produces HAL-style JSON over HTTPS,
and any REST library can be used to access it. On GitHub, we also host
a few API libraries that you can use to make API access easier, such as our
[PHP API client](https://github.com/upsun/upsun-sdk-php).
In order to use the API you will first need to have an [Upsun
account](https://auth.upsun.com/register/)
and [create an API Token](https://docs.upsun.com/anchors/cli/api-token/).
# Authentication
## OAuth2
API authentication is done with OAuth2 access tokens.
### API tokens
You can use an API token as one way to get an OAuth2 access token. This
is particularly useful in scripts, e.g. for CI pipelines.
To create an API token, go to the "API Tokens" section
of the "Account Settings" tab on the [Console](https://console.upsun.com).
To exchange this API token for an access token, a `POST` request
must be made to `https://auth.upsun.com/oauth2/token`.
The request will look like this in cURL:
curl -u platform-api-user: \
-d 'grant_type=api_token&api_token=API_TOKEN' \
https://auth.upsun.com/oauth2/token
This will return a "Bearer" access token that
can be used to authenticate further API requests, for example:
{
"access_token": "abcdefghij1234567890",
"expires_in": 900,
"token_type": "bearer"
}
### Using the Access Token
To authenticate further API requests, include this returned bearer token
in the `Authorization` header. For example, to retrieve a list of
[Projects](#tag/Project)
accessible by the current user, you can make the following request
(substituting the dummy token for your own):
curl -H "Authorization: Bearer abcdefghij1234567890" \
https://api.upsun.com/projects
# HAL Links
Most endpoints in the API return fields which defines a HAL
(Hypertext Application Language) schema for the requested endpoint.
The particular objects returns and their contents can vary by endpoint.
The payload examples we give here for the requests do not show these
elements. These links can allow you to create a fully dynamic API client
that does not need to hardcode any method or schema.
Unless they are used for pagination we do not show the HAL links in the
payload examples in this documentation for brevity and as their content
is contextual (based on the permissions of the user).
## _links Objects
Most endpoints that respond to `GET` requests will include a `_links` object
in their response. The `_links` object contains a key-object pair labelled
`self`, which defines
two further key-value pairs:
* `href` - A URL string referring to the fully qualified name of the
returned object. For many endpoints, this will be the direct link to the API
endpoint on the region gateway, rather than on the general API gateway. This
means it may reference a host of, for example, `eu-2.platform.sh` rather
than `api.upsun.com`.
* `meta` - An object defining the OpenAPI Specification (OAS) [schema
object](https://swagger.io/specification/#schemaObject) of the component
returned by the endpoint.
There may be zero or more other fields in the `_links` object resembling
fragment identifiers
beginning with a hash mark, e.g. `#edit` or `#delete`. Each of these keys
refers to a JSON object containing two key-value pairs:
* `href` - A URL string referring to the path name of endpoint which can
perform the action named in the key.
* `meta` - An object defining the OAS schema of the endpoint. This consists
of a key-value pair, with the key defining an HTTP method and the value
defining the [operation
object](https://swagger.io/specification/#operationObject) of the endpoint.
To use one of these HAL links, you must send a new request to the URL
defined
in the `href` field which contains a body defined the schema object in the
`meta` field.
For example, if you make a request such as `GET
/projects/abcdefghij1234567890`, the `_links`
object in the returned response will include the key `#delete`. That object
will look something like this fragment:
```
"#delete": {
"href": "/api/projects/abcdefghij1234567890",
"meta": {
"delete": {
"responses": {
. . . // Response definition omitted for space
},
"parameters": []
}
}
}
```
To use this information to delete a project, you would then send a `DELETE`
request to the endpoint
`https://api.upsun.com/api/projects/abcdefghij1234567890`
with no body or parameters to delete the project that was originally
requested.
## _embedded Objects
Requests to endpoints which create or modify objects, such as `POST`,
`PATCH`, or `DELETE`
requests, will include an `_embedded` key in their response. The object
represented by this key will contain the created or modified object. This
object is identical to what would be returned by a subsequent `GET` request
for the object referred to by the endpoint.
x-logo:
url: https://docs.upsun.com/images/upsun-api.svg
href: https://upsun.com/#section/Introduction
altText: Upsun logo
servers:
- url: '{schemes}://api.upsun.com'
description: The Upsun.com API gateway
variables:
schemes:
default: https
security:
- BearerAuth: []
tags:
- name: Cert Management
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.
- name: Environment
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.
- name: Environment Type
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.
- name: Environment Backups
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/).
- name: Environment Variables
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.
- name: Autoscaling
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.
- name: Project
description: >
## 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 application's data storage,
the production and staging environments, and the backups of those
environments.
When you create a new project, you start with a single
[Environment](#tag/Environment) called *Master*,
corresponding to the master branch in the Git repository of
the project—this will be your production environment.
If you connect your project to an external Git repo
using one of our [Third-Party Integrations](#tag/Third-Party-Integrations)
a new development environment can be created for each branch
or pull request created in the repository. When a new development
environment is created, the production environment's data
will be cloned on-the-fly, giving you an isolated, production-ready
test environment.
This set of API endpoints can be used to retrieve a list of projects
associated with an API key, as well as create and update the parameters
of existing projects.
> **Note**:
>
> To list projects or to create a new project, use
[`/subscriptions`](#tag/Subscriptions).
- name: Project Variables
description: >
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 be made available at both build
time and runtime. For more information on project variables,
see the
[Variables](https://docs.upsun.com/anchors/variables/set/project/create/)
section of the documentation.
- name: Project Settings
description: >
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 existing Git repository.
The other properties can only be set by a privileged user.
- name: Repository
description: >
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, you can retrieve objects from
the Git repository in the same way that you would in a local environment.
- name: Domain Management
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.
- name: Routing
description: >
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 synchronized with their parent.
More information about routing can be found in the
[Routes](https://docs.upsun.com/anchors/routes/)
section of the documentation.
- name: Source Operations
description: >
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 operations is
[available in our user
documentation](https://docs.upsun.com/anchors/app/source-operations/).
- name: Deployment Target
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.
- name: Deployments
description: |
The deployments endpoints gives detailed information about the actual
deployment of an active environment. Currently, it returns the _current_
deployment with information about the different apps, services, and
routes contained within.
- name: Third-Party Integrations
description: |
Upsun can easily integrate with many third-party services, including
Git hosting services (GitHub, GitLab, and Bitbucket),
health notification services (email, Slack, PagerDuty),
performance analytics platforms (New Relic, Blackfire, Tideways),
and webhooks.
For clarification about what information each field requires, see the
[External Integrations](https://docs.upsun.com/anchors/integrations/)
documentation. NOTE: The names of the CLI arguments listed in the
documentation are not always named exactly the same as the
required body fields in the API request.
- name: MFA
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.
- name: Subscriptions
description: >
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 features.
- name: Orders
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.
- name: Invoices
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.
- name: Vouchers
description: >
These endpoints can be used to retrieve vouchers associated with a
particular
user as well as apply a voucher to a particular user.
- name: Records
description: >
These endpoints retrieve information about which plans were assigned to a
particular
project at which time.
- name: Support
description: >
These endpoints can be used to retrieve information about support ticket
priority
and allow you to submit new ticket to the Upsun Support Team.
- name: System Information
description: >
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 privileged users.
paths:
/projects/{projectId}/capabilities:
get:
tags:
- Project
summary: Get a project's capabilities
description: >
Get a list of capabilities on a project, as defined by the billing
system.
For instance, one special capability that could be defined on a project
is
large development environments.
operationId: get-projects-capabilities
parameters:
- in: path
required: true
schema:
type: string
name: projectId
responses:
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectCapabilities'
components:
schemas:
ProjectCapabilities:
type: object
properties:
custom_domains:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: If true, custom domains can be added to the project.
environments_with_domains_limit:
type: integer
title: Domains limit
description: >-
Limit on the amount of non-production environments that can have
domains set
required:
- enabled
- environments_with_domains_limit
additionalProperties: false
title: Custom Domains
description: ''
source_operations:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: If true, source operations can be triggered.
required:
- enabled
additionalProperties: false
title: Source Operations
description: ''
runtime_operations:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: If true, runtime operations can be triggered.
required:
- enabled
additionalProperties: false
title: Runtime Operations
description: ''
tasks:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: If true, background tasks can be triggered.
required:
- enabled
additionalProperties: false
title: Tasks
description: ''
outbound_firewall:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: If true, outbound firewall can be used.
required:
- enabled
additionalProperties: false
title: Outbound Firewall
description: ''
metrics:
type: object
properties:
max_range:
type: string
title: Max range
description: Limit on the maximum time range allowed in metrics retrieval
required:
- max_range
additionalProperties: false
title: Metrics
description: ''
logs_forwarding:
type: object
properties:
max_extra_payload_size:
type: integer
title: Max extra payload size
description: >-
Limit on the maximum size for the custom extra attributes added
to the forwarded logs payload
required:
- max_extra_payload_size
additionalProperties: false
title: Logs Forwarding
description: ''
guaranteed_resources:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: If true, guaranteed resources can be used
instance_limit:
type: integer
title: Instance limit
description: Instance limit for guaranteed resources
required:
- enabled
- instance_limit
additionalProperties: false
title: Guaranteed Resources
description: ''
images:
type: object
additionalProperties:
type: object
additionalProperties:
type: object
properties:
available:
type: boolean
title: Available
description: The image is available for deployment
required:
- available
additionalProperties: false
title: Images
description: ''
instance_limit:
type: integer
title: Instance limit
description: Maximum number of instance per service
build_resources:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: If true, build resources can be modified.
max_cpu:
type: number
format: float
title: CPU
description: ''
max_memory:
type: integer
title: Memory
description: ''
required:
- enabled
- max_cpu
- max_memory
additionalProperties: false
title: Build Resources
description: ''
data_retention:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: If true, data retention configuration can be modified.
required:
- enabled
additionalProperties: false
title: Data Retention
description: ''
autoscaling:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: If true, autoscaling can be configured.
required:
- enabled
additionalProperties: false
title: Autoscaling
description: ''
integrations:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: If true, integrations can be used
config:
type: object
properties:
newrelic:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: New Relic
description: New Relic log-forwarding integration configurations
sumologic:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Sumo Logic
description: Sumo Logic log-forwarding integration configurations
splunk:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Splunk
description: Splunk log-forwarding integration configurations
httplog:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: HTTP log-forwarding
description: HTTP log-forwarding integration configurations
syslog:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Syslog
description: Syslog log-forwarding integration configurations
webhook:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Webhook
description: Webhook integration configurations
script:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Script
description: Script integration configurations
github:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: GitHub
description: GitHub integration configurations
gitlab:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: GitLab
description: GitLab integration configurations
bitbucket:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Bitbucket
description: Bitbucket integration configurations
bitbucket_server:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Bitbucket Server
description: Bitbucket server integration configurations
health.email:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Health Email
description: Health Email notification integration configurations
health.webhook:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Health WebHook
description: Health Webhook notification integration configurations
health.pagerduty:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Health PagerDuty
description: Health PagerDuty notification integration configurations
health.slack:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Health Slack
description: Health Slack notification integration configurations
cdn.fastly:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Fastly CDN
description: Fastly CDN integration configurations
blackfire:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: Blackfire
description: Blackfire integration configurations
otlplog:
type: object
properties:
enabled:
type: boolean
title: Enabled
description: The integration is enabled.
role:
type: string
title: Role
description: Minimum required role for creating the integration.
additionalProperties: false
title: OpenTelemetry
description: OpenTelemetry log-forwarding integration configurations
additionalProperties: false
title: Config
description: ''
allowed_integrations:
type: array
items:
type: string
title: Allowed Integrations
description: List of integrations allowed to be created
required:
- enabled
additionalProperties: false
title: Integrations
description: ''
required:
- tasks
- metrics
- logs_forwarding
- guaranteed_resources
- images
- instance_limit
- build_resources
- data_retention
- autoscaling
additionalProperties: false
securitySchemes:
BearerAuth:
type: http
scheme: bearer
````