Platform.sh Environment API

openapi: 3.2.0
info:
  title: Upsun.com Rest Environment API
  version: '1.0'
  contact:
    name: Support
    url: https://upsun.com/contact-us/
  termsOfService: https://upsun.com/trust-center/legal/tos/
  description: "# Introduction\n\nUpsun, formerly Platform.sh, is a container-based Platform-as-a-Service. Our main API\nis simply Git. With a single `git push` and a couple of YAML files in\nyour repository you can deploy an arbitrarily complex cluster.\nEvery [**Project**](#tag/Project) can have multiple applications (PHP,\nNode.js, Python, Ruby, Go, etc.) and managed, automatically\nprovisioned services (databases, message queues, etc.).\n\nEach project also comes with multiple concurrent\nlive staging/development [**Environments**](#tag/Environment).\nThese ephemeral development environments\nare automatically created every time you push a new branch or create a\npull request, and each has a full copy of the data of its parent branch,\nwhich is created on-the-fly in seconds.\n\nOur Git implementation supports integrations with third party Git\nproviders such as GitHub, Bitbucket, or GitLab, allowing you to simply\nintegrate Upsun into your existing workflow.\n\n## Using the REST API\n\nIn addition to the Git API, we also offer a REST API that allows you to manage\nevery aspect of the platform, from managing projects and environments,\nto accessing accounts and subscriptions, to creating robust workflows\nand integrations with your CI systems and internal services.\n\nThese API docs are generated from a standard **OpenAPI (Swagger)** Specification document\nwhich you can find here in [YAML](openapispec-upsun.yaml) and in [JSON](openapispec-upsun.json) formats.\n\nThis RESTful API consumes and produces HAL-style JSON over HTTPS,\nand any REST library can be used to access it. On GitHub, we also host\na few API libraries that you can use to make API access easier, such as our\n[PHP API client](https://github.com/upsun/upsun-sdk-php).\n\nIn order to use the API you will first need to have an [Upsun account](https://auth.upsun.com/register/)\nand [create an API Token](https://docs.upsun.com/anchors/cli/api-token/).\n\n# Authentication\n\n## OAuth2\n\nAPI authentication is done with OAuth2 access tokens.\n\n### API tokens\n\nYou can use an API token as one way to get an OAuth2 access token. This\nis particularly useful in scripts, e.g. for CI pipelines.\n\nTo create an API token, go to the \"API Tokens\" section\nof the \"Account Settings\" tab on the [Console](https://console.upsun.com).\n\nTo exchange this API token for an access token, a `POST` request\nmust be made to `https://auth.upsun.com/oauth2/token`.\n\nThe request will look like this in cURL:\n\n<pre>\ncurl -u platform-api-user: \\\n    -d 'grant_type=api_token&amp;api_token=<em><b>API_TOKEN</b></em>' \\\n    https://auth.upsun.com/oauth2/token\n</pre>\n\nThis will return a \"Bearer\" access token that\ncan be used to authenticate further API requests, for example:\n\n<pre>\n{\n    \"access_token\": \"<em><b>abcdefghij1234567890</b></em>\",\n    \"expires_in\": 900,\n    \"token_type\": \"bearer\"\n}\n</pre>\n\n### Using the Access Token\n\nTo authenticate further API requests, include this returned bearer token\nin the `Authorization` header. For example, to retrieve a list of\n[Projects](#tag/Project)\naccessible by the current user, you can make the following request\n(substituting the dummy token for your own):\n\n<pre>\ncurl -H \"Authorization: Bearer <em><b>abcdefghij1234567890</b></em>\" \\\n    https://api.upsun.com/projects\n</pre>\n\n# HAL Links\n\nMost endpoints in the API return fields which defines a HAL\n(Hypertext Application Language) schema for the requested endpoint.\nThe particular objects returns and their contents can vary by endpoint.\nThe payload examples we give here for the requests do not show these\nelements. These links can allow you to create a fully dynamic API client\nthat does not need to hardcode any method or schema.\n\nUnless they are used for pagination we do not show the HAL links in the\npayload examples in this documentation for brevity and as their content\nis contextual (based on the permissions of the user).\n\n## _links Objects\n\nMost endpoints that respond to `GET` requests will include a `_links` object\nin their response. The `_links` object contains a key-object pair labelled `self`, which defines\ntwo further key-value pairs:\n\n* `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`.\n* `meta` - An object defining the OpenAPI Specification (OAS) [schema object](https://swagger.io/specification/#schemaObject) of the component returned by the endpoint.\n\nThere may be zero or more other fields in the `_links` object resembling fragment identifiers\nbeginning with a hash mark, e.g. `#edit` or `#delete`. Each of these keys\nrefers to a JSON object containing two key-value pairs:\n\n* `href` - A URL string referring to the path name of endpoint which can perform the action named in the key.\n* `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.\n\nTo use one of these HAL links, you must send a new request to the URL defined\nin the `href` field which contains a body defined the schema object in the `meta` field.\n\nFor example, if you make a request such as `GET /projects/abcdefghij1234567890`, the `_links`\nobject in the returned response will include the key `#delete`. That object\nwill look something like this fragment:\n\n```\n\"#delete\": {\n    \"href\": \"/api/projects/abcdefghij1234567890\",\n    \"meta\": {\n        \"delete\": {\n            \"responses\": {\n                . . . // Response definition omitted for space\n            },\n            \"parameters\": []\n        }\n    }\n}\n```\n\nTo use this information to delete a project, you would then send a `DELETE`\nrequest to the endpoint `https://api.upsun.com/api/projects/abcdefghij1234567890`\nwith no body or parameters to delete the project that was originally requested.\n\n## _embedded Objects\n\nRequests to endpoints which create or modify objects, such as `POST`, `PATCH`, or `DELETE`\nrequests, will include an `_embedded` key in their response. The object\nrepresented by this key will contain the created or modified object. This\nobject is identical to what would be returned by a subsequent `GET` request\nfor the object referred to by the endpoint.\n"
  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: 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.

    '
paths:
  /projects/{projectId}/environments:
    get:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      operationId: list-projects-environments
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentCollection'
      tags:
      - Environment
      summary: Get list of project environments
      description: 'Retrieve a list of a project''s existing environments and the

        information associated with each environment.

        '
  /projects/{projectId}/environments/{environmentId}:
    get:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: get-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
      tags:
      - Environment
      summary: Get an environment
      description: Retrieve the details of a single existing environment.
    patch:
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentPatch'
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: update-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      tags:
      - Environment
      summary: Update an environment
      description: Update the details of a single existing environment.
    delete:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: delete-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      tags:
      - Environment
      summary: Delete an environment
      description: Delete a specified environment.
  /projects/{projectId}/environments/{environmentId}/activate:
    post:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: activate-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentActivateInput'
      tags:
      - Environment
      summary: Activate an environment
      description: Set the specified environment's status to active
  /projects/{projectId}/environments/{environmentId}/branch:
    post:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: branch-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentBranchInput'
      tags:
      - Environment
      summary: Branch an environment
      description: 'Create a new environment as a branch of the current environment.

        '
  /projects/{projectId}/environments/{environmentId}/deactivate:
    post:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: deactivate-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      tags:
      - Environment
      summary: Deactivate an environment
      description: 'Destroy all services and data running on this environment so that

        only the Git branch remains. The environment can be reactivated

        later at any time; reactivating an environment will sync data

        from the parent environment and redeploy.


        **NOTE: ALL DATA IN THIS ENVIRONMENT WILL BE IRREVOCABLY LOST**

        '
  /projects/{projectId}/environments/{environmentId}/deploy:
    post:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: deploy-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentDeployInput'
      tags:
      - Environment
      summary: Deploy an environment
      description: 'Trigger a controlled [manual deployment](https://docs.upsun.com/learn/overview/build-deploy.html#manual-deployment)

        to release all the staged changes

        '
  /projects/{projectId}/environments/{environmentId}/initialize:
    post:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: initialize-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentInitializeInput'
      tags:
      - Environment
      summary: Initialize a new environment
      description: "Initialize and configure a new environment with an existing repository.\nThe payload is the url of a git repository with a profile name:\n\n```\n{\n    \"repository\": \"git@github.com:platformsh/a-project-template.git@master\",\n    \"profile\": \"Example Project\",\n    \"files\": [\n      {\n        \"mode\": 0600,\n        \"path\": \"config.json\",\n        \"contents\": \"XXXXXXXX\"\n      }\n    ]\n}\n```\nIt can optionally carry additional files that will be committed to the\nrepository, the POSIX file mode to set on each file, and the base64-encoded\ncontents of each file.\n\nThis endpoint can also add a second repository\nURL in the `config` parameter that will be added to the contents of the first.\nThis allows you to put your application in one repository and the Upsun\nYAML configuration files in another.\n"
  /projects/{projectId}/environments/{environmentId}/maintenance-redeploy:
    post:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: maintenance-redeploy-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      tags:
      - Environment
  /projects/{projectId}/environments/{environmentId}/merge:
    post:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: merge-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentMergeInput'
      tags:
      - Environment
      summary: Merge an environment
      description: 'Merge an environment into its parent. This means that code changes

        from the branch environment will be merged into the parent branch, and

        the parent branch will be rebuilt and deployed with the new code changes,

        retaining the existing data in the parent environment.

        '
  /projects/{projectId}/environments/{environmentId}/pause:
    post:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: pause-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      tags:
      - Environment
      summary: Pause an environment
      description: 'Pause an environment, stopping all services and applications (except the router).


        Development environments are often used for a limited time and then abandoned.

        To prevent unnecessary consumption of resources, development environments that

        haven''t been redeployed in 14 days are automatically paused.


        You can pause an environment manually at any time using this endpoint. Further

        information is available in our [public documentation](https://docs.upsun.com/anchors/environments/paused/).

        '
  /projects/{projectId}/environments/{environmentId}/redeploy:
    post:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: redeploy-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      tags:
      - Environment
      summary: Redeploy an environment
      description: Trigger the redeployment sequence of an environment.
  /projects/{projectId}/environments/{environmentId}/resume:
    post:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: resume-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      tags:
      - Environment
      summary: Resume a paused environment
      description: 'Resume a paused environment, restarting all services and applications.


        Development environments that haven''t been used for 14 days will be paused

        automatically. They can be resumed via a redeployment or manually using this

        endpoint or the CLI as described in the [public documentation](https://docs.upsun.com/anchors/environments/paused/).

        '
  /projects/{projectId}/environments/{environmentId}/synchronize:
    post:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: synchronize-environment
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentSynchronizeInput'
      tags:
      - Environment
      summary: Synchronize a child environment with its parent
      description: 'This synchronizes the code and/or data of an environment with that of

        its parent, then redeploys the environment. Synchronization is only

        possible if a branch has no unmerged commits and it can be fast-forwarded.


        If data synchronization is specified, the data in the environment will

        be overwritten with that of its parent.

        '
components:
  schemas:
    AcceptedResponse:
      type: object
      properties:
        status:
          type: string
          title: Status text
          description: The status text of the response
        code:
          type: integer
          title: Status code
          description: The status code of the response
      required:
      - status
      - code
      additionalProperties: false
    EnvironmentInitializeInput:
      type: object
      properties:
        profile:
          type: string
          title: Profile
          description: Name of the profile to show in the UI
        repository:
          type: string
          title: Repository
          description: Repository to clone from
        config:
          type:
          - string
          - 'null'
          title: Configuration repository
          description: Repository to clone the configuration files from
        files:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
                title: Path
                description: The path to the file.
              mode:
                type: integer
                title: Mode
                description: The octal value of the file protection mode.
              contents:
                type: string
                title: Contents
                description: The contents of the file (base64 encoded).
            required:
            - path
            additionalProperties: false
          title: Files
          description: A list of files to add to the repository during initialization
        resources:
          type:
          - object
          - 'null'
          properties:
            init:
              type:
              - string
              - 'null'
              enum:
              - default
              - minimum
              title: Init Resources
              description: The resources used when initializing the environment
          additionalProperties: false
          title: Resources
          description: ''
      required:
      - profile
      - repository
      additionalProperties: false
    EnvironmentMergeInput:
      type: object
      properties:
        resources:
          type:
          - object
          - 'null'
          properties:
            init:
              type:
              - string
              - 'null'
              enum:
              - child
              - default
              - manual
              - minimum
              title: Init Resources
              description: The resources used when merging an environment
          additionalProperties: false
          title: Resources
          description: ''
      additionalProperties: false
    EnvironmentActivateInput:
      type: object
      properties:
        resources:
          type:
          - object
          - 'null'
          properties:
            init:
              type:
              - string
              - 'null'
              enum:
              - default
              - minimum
              - parent
              title: Init Resources
              description: The resources used when activating an environment
          additionalProperties: false
          title: Resources
          description: ''
      additionalProperties: false
    EnvironmentDeployInput:
      type: object
      properties:
        strategy:
          type: string
          enum:
          - rolling
          - stopstart
          title: Deployment strategy
          description: The deployment strategy (`rolling` or `stopstart`)
      additionalProperties: false
    EnvironmentSynchronizeInput:
      type: object
      properties:
        synchronize_code:
          type: boolean
          title: Is code synchronized
          description: Synchronize code?
        rebase:
          type: boolean
          title: Is code rebased
          description: Synchronize code by rebasing instead of merging
        synchronize_data:
          type: boolean
          title: Is data synchronized
          description: Synchronize data?
        synchronize_resources:
          type: boolean
          title: Are resources synchronized
          description: Synchronize resources?
      additionalProperties: false
    Environment:
      type: object
      properties:
        id:
          type: string
          title: Environment Identifier
          description: The identifier of Environment
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          title: Creation date
          description: The creation date
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          title: Update date
          description: The update date
        name:
          type: string
          title: Name
          description: The name of the environment
        machine_name:
          type: string
          title: Machine name
          description: The machine name for the environment
        title:
          type: string
          title: Title
          description: The title of the environment
        attributes:
          type: object
          additionalProperties:
            type: string
          title: Arbitrary attributes
          description: Arbitrary attributes attached to this resource
        type:
          type: string
          enum:
          - development
          - production
          - staging
          title: Type
          description: The type of environment (`production`, `staging` or `development`), if not provided, a default will be calculated
        parent:
          type:
          - string
          - 'null'
          title: Parent environment
          description: The name of the parent environment
        default_domain:
          type:
          - string
          - 'null'
          title: Default domain
          description: The default domain
        has_domains:
          type: boolean
          title: Has domains
          description: Whether the environment has domains
        clone_parent_on_create:
          type: boolean
          title: Clone parent on create
          description: Clone data when creating that environment
        deployment_target:
          type:
          - string
          - 'null'
          title: Deployment target
          description: Deployment target of the environment
        is_pr:
          type: boolean
          title: Is pull or merge request
          description: Is this environment a pull request / merge request
        has_remote:
          type: boolean
          title: Has remote
          description: Does this environment have a remote repository
        status:
          type: string
          enum:
          - active
          - deleting
          - dirty
          - inactive
          - paused
          title: Status
          description: The status of the environment
        http_access:
          type: object
          properties:
            is_enabled:
              type: boolean
              title: Is enabled
              description: Whether http_access control is enabled
            addresses:
              type: array
              items:
                type: object
                properties:
                  permission:
                    type: string
                    enum:
                    - allow
                    - deny
                    title: Permission
                    description: ''
                  address:
                    type: string
                    title: Address
                    description: IP address or CIDR
                required:
                - permission
                - address
                additionalProperties: false
              title: Address grants
              description: ''
            basic_auth:
              type: object
              additionalProperties:
                type: string
              title: Basic auth grants
              description: ''
          required:
          - is_enabled
          - addresses
          - basic_auth
          additionalProperties: false
          title: HTTP access permissions
          description: The HTTP access permissions for this environment
        enable_smtp:
          type: boolean
          title: Enable SMTP
          description: Whether to configure SMTP for this environment
        restrict_robots:
          type: boolean
          title: Restrict robots
          description: Whether to restrict robots for this environment
        edge_hostname:
          type: string
          title: Edge hostname
          description: The hostname to use as the CNAME
        deployment_state:
          type:
          - object
          - 'null'
          properties:
            last_state_update_successful:
              type: boolean
              title: Last state update successful
              description: Whether the last deployment has correctly switched state (does not mean it was successful)
            last_deployment_successful:
              type: boolean
              title: Last deployment successful
              description: Whether the last deployment was successful
            last_deployment_failure_reason:
              type:
              - string
              - 'null'
              enum:
              - error
              - shell
              title: Last deployment failure reason
              description: The reason for failure of the last deployment
            last_deployment_commands:
              type: array
              items:
                type: object
                properties:
                  app:
                    type: string
                    title: Application
                    description: The application name
                  type:
                    type: string
                    title: Type
                    description: The command type
                  exit_code:
                    type: integer
                    title: Exit status code
                    description: The exit status code of the command
                required:
                - app
                - type
                - exit_code
                additionalProperties: false
              title: Last deployment commands
              description: The commands executed during the last deployment
            last_deployment_at:
              type:
              - string
              - 'null'
              format: date-time
              title: Last deployment datetime
              description: Datetime of the last deployment
            last_autoscale_up_at:
              type:
              - string
              - 'null'
              format: date-time
              title: Last autoscale up datetime
              description: Datetime of the last autoscale up deployment
            last_autoscale_down_at:
              type:
              - string
              - 'null'
              format: date-time
              title: Last autoscale down datetime
              description: Dateti

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/platform.sh/refs/heads/main/openapi/platform.sh-environment-api-openapi.yml