Platform.sh Deployment API

openapi: 3.2.0
info:
  title: Platform.sh Deployment API
  version: '1.0'
  contact:
    name: Support
    url: https://upsun.com/contact-us/
  termsOfService: https://upsun.com/trust-center/legal/tos/
  x-logo:
    url: https://docs.upsun.com/images/upsun-api.svg
    href: https://upsun.com/#section/Introduction
    altText: Upsun logo
  description: 'Operations tagged Deployment across 2 of this provider''s published API definitions: platform.sh-developer-portal-openapi-original.json, platform.sh-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: '{schemes}://api.upsun.com'
  description: The Upsun.com API gateway
  variables:
    schemes:
      default: https
tags:
- name: Deployment
paths:
  /projects/{projectId}/environments/{environmentId}/deployments:
    get:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      operationId: list-projects-environments-deployments
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentCollection'
      tags:
      - Deployment
      summary: Get an environment's deployment information
      description: 'Retrieve the read-only configuration of an environment''s deployment.

        The returned information is everything required to

        recreate a project''s current deployment.


        More specifically, the objects

        returned by this endpoint contain the configuration derived from the

        repository''s YAML configuration file: `.upsun/config.yaml`.


        Additionally, any values deriving from environment variables, the

        domains attached to a project, project access settings, etc. are

        included here.


        This endpoint currently returns a list containing a single deployment

        configuration with an `id` of `current`. This may be subject to change

        in the future.'
      security:
      - OAuth2: []
    servers:
    - url: '{schemes}://api.upsun.com'
      description: The Upsun.com API gateway
      variables:
        schemes:
          default: https
  /projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}:
    get:
      parameters:
      - in: path
        required: true
        schema:
          type: string
        name: projectId
      - in: path
        required: true
        schema:
          type: string
        name: environmentId
      - in: path
        required: true
        schema:
          type: string
        name: deploymentId
      operationId: get-projects-environments-deployments
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
      tags:
      - Deployment
      summary: Get a single environment deployment
      description: 'Retrieve a single deployment configuration with an id of `current`. This may be subject to change in the future.

        Only `current` can be queried.'
      security:
      - OAuth2: []
    servers:
    - url: '{schemes}://api.upsun.com'
      description: The Upsun.com API gateway
      variables:
        schemes:
          default: https
components:
  schemas:
    ProxyRoute:
      type: object
      properties:
        id:
          type: string
          title: ProxyRoute Identifier
          description: The identifier of ProxyRoute
        primary:
          type:
          - boolean
          - 'null'
          title: Is primary
          description: This route is the primary route of the environment
        production_url:
          type:
          - string
          - 'null'
          title: Production URL
          description: How this URL route would look on production environment
        attributes:
          type: object
          additionalProperties:
            type: string
          title: Arbitrary attributes
          description: Arbitrary attributes attached to this resource
        type:
          type: string
          enum:
          - proxy
          - redirect
          - upstream
          title: Route type
          description: Route type.
        tls:
          type: object
          properties:
            strict_transport_security:
              type: object
              properties:
                enabled:
                  type:
                  - boolean
                  - 'null'
                  title: Is enabled
                  description: Whether strict transport security is enabled or not.
                include_subdomains:
                  type:
                  - boolean
                  - 'null'
                  title: Is subdomains included
                  description: Whether the strict transport security policy should include all subdomains.
                preload:
                  type:
                  - boolean
                  - 'null'
                  title: Is strict transport security preloaded
                  description: Whether the strict transport security policy should be preloaded in browsers.
              required:
              - enabled
              - include_subdomains
              - preload
              additionalProperties: false
              title: Strict-Transport-Security options.
              description: ''
            min_version:
              type:
              - string
              - 'null'
              enum:
              - TLSv1.0
              - TLSv1.1
              - TLSv1.2
              - TLSv1.3
              title: Minimum TLS version
              description: The minimum TLS version to support.
            client_authentication:
              type:
              - string
              - 'null'
              enum:
              - request
              - require
              title: Client authentication
              description: The type of client authentication to request.
            client_certificate_authorities:
              type: array
              items:
                type: string
              title: Client certificate authorities
              description: Certificate authorities to validate the client certificate against. If not specified, a default set of trusted CAs will be used.
          required:
          - strict_transport_security
          - min_version
          - client_authentication
          - client_certificate_authorities
          additionalProperties: false
          title: TLS settings
          description: TLS settings for the route.
        to:
          type: string
          title: Proxy destination
          description: ''
      required:
      - primary
      - id
      - production_url
      - attributes
      - type
      - tls
      - to
      additionalProperties: false
    DeploymentCollection:
      type: array
      items:
        $ref: '#/components/schemas/Deployment'
    RedirectRoute:
      type: object
      properties:
        id:
          type: string
          title: RedirectRoute Identifier
          description: The identifier of RedirectRoute
        primary:
          type:
          - boolean
          - 'null'
          title: Is primary
          description: This route is the primary route of the environment
        production_url:
          type:
          - string
          - 'null'
          title: Production URL
          description: How this URL route would look on production environment
        attributes:
          type: object
          additionalProperties:
            type: string
          title: Arbitrary attributes
          description: Arbitrary attributes attached to this resource
        type:
          type: string
          enum:
          - proxy
          - redirect
          - upstream
          title: Route type
          description: Route type.
        tls:
          type: object
          properties:
            strict_transport_security:
              type: object
              properties:
                enabled:
                  type:
                  - boolean
                  - 'null'
                  title: Is enabled
                  description: Whether strict transport security is enabled or not.
                include_subdomains:
                  type:
                  - boolean
                  - 'null'
                  title: Is subdomains included
                  description: Whether the strict transport security policy should include all subdomains.
                preload:
                  type:
                  - boolean
                  - 'null'
                  title: Is strict transport security preloaded
                  description: Whether the strict transport security policy should be preloaded in browsers.
              required:
              - enabled
              - include_subdomains
              - preload
              additionalProperties: false
              title: Strict-Transport-Security options.
              description: ''
            min_version:
              type:
              - string
              - 'null'
              enum:
              - TLSv1.0
              - TLSv1.1
              - TLSv1.2
              - TLSv1.3
              title: Minimum TLS version
              description: The minimum TLS version to support.
            client_authentication:
              type:
              - string
              - 'null'
              enum:
              - request
              - require
              title: Client authentication
              description: The type of client authentication to request.
            client_certificate_authorities:
              type: array
              items:
                type: string
              title: Client certificate authorities
              description: Certificate authorities to validate the client certificate against. If not specified, a default set of trusted CAs will be used.
          required:
          - strict_transport_security
          - min_version
          - client_authentication
          - client_certificate_authorities
          additionalProperties: false
          title: TLS settings
          description: TLS settings for the route.
        to:
          type: string
          title: Redirect destination
          description: ''
        redirects:
          type: object
          properties:
            expires:
              type: string
              title: Expires
              description: The amount of time, in seconds, to cache the redirects.
            paths:
              type: object
              additionalProperties:
                type: object
                properties:
                  regexp:
                    type: boolean
                    title: Is regexp
                    description: Whether the path is a regular expression.
                  to:
                    type: string
                    title: Redirect URL
                    description: The URL to redirect to.
                  prefix:
                    type:
                    - boolean
                    - 'null'
                    title: Is prefix
                    description: Whether to redirect all the paths that start with the path.
                  append_suffix:
                    type:
                    - boolean
                    - 'null'
                    title: Append suffix
                    description: Whether to append the incoming suffix to the redirected URL.
                  code:
                    type: integer
                    enum:
                    - 301
                    - 302
                    - 307
                    - 308
                    title: Redirect code
                    description: The redirect code to use.
                  expires:
                    type:
                    - string
                    - 'null'
                    title: Expires
                    description: The amount of time, in seconds, to cache the redirects.
                required:
                - regexp
                - to
                - prefix
                - append_suffix
                - code
                - expires
                additionalProperties: false
              title: Path
              description: The paths to redirect
          required:
          - expires
          - paths
          additionalProperties: false
          title: Redirect configuration
          description: The configuration of the redirects.
      required:
      - primary
      - id
      - production_url
      - attributes
      - type
      - tls
      - to
      - redirects
      additionalProperties: false
    UpstreamRoute:
      type: object
      properties:
        id:
          type: string
          title: UpstreamRoute Identifier
          description: The identifier of UpstreamRoute
        primary:
          type:
          - boolean
          - 'null'
          title: Is primary
          description: This route is the primary route of the environment
        production_url:
          type:
          - string
          - 'null'
          title: Production URL
          description: How this URL route would look on production environment
        attributes:
          type: object
          additionalProperties:
            type: string
          title: Arbitrary attributes
          description: Arbitrary attributes attached to this resource
        type:
          type: string
          enum:
          - proxy
          - redirect
          - upstream
          title: Route type
          description: Route type.
        tls:
          type: object
          properties:
            strict_transport_security:
              type: object
              properties:
                enabled:
                  type:
                  - boolean
                  - 'null'
                  title: Is enabled
                  description: Whether strict transport security is enabled or not.
                include_subdomains:
                  type:
                  - boolean
                  - 'null'
                  title: Is subdomains included
                  description: Whether the strict transport security policy should include all subdomains.
                preload:
                  type:
                  - boolean
                  - 'null'
                  title: Is strict transport security preloaded
                  description: Whether the strict transport security policy should be preloaded in browsers.
              required:
              - enabled
              - include_subdomains
              - preload
              additionalProperties: false
              title: Strict-Transport-Security options.
              description: ''
            min_version:
              type:
              - string
              - 'null'
              enum:
              - TLSv1.0
              - TLSv1.1
              - TLSv1.2
              - TLSv1.3
              title: Minimum TLS version
              description: The minimum TLS version to support.
            client_authentication:
              type:
              - string
              - 'null'
              enum:
              - request
              - require
              title: Client authentication
              description: The type of client authentication to request.
            client_certificate_authorities:
              type: array
              items:
                type: string
              title: Client certificate authorities
              description: Certificate authorities to validate the client certificate against. If not specified, a default set of trusted CAs will be used.
          required:
          - strict_transport_security
          - min_version
          - client_authentication
          - client_certificate_authorities
          additionalProperties: false
          title: TLS settings
          description: TLS settings for the route.
        cache:
          type: object
          properties:
            enabled:
              type: boolean
              title: Is enabled
              description: Whether the cache is enabled.
            default_ttl:
              type: integer
              title: Default TTL
              description: The TTL to apply when the response doesn't specify one. Only applies to static files.
            cookies:
              type: array
              items:
                type: string
              title: Cookies
              description: The cookies to take into account for the cache key.
            headers:
              type: array
              items:
                type: string
              title: Headers
              description: The headers to take into account for the cache key.
          required:
          - enabled
          - default_ttl
          - cookies
          - headers
          additionalProperties: false
          title: Cache configuration
          description: Cache configuration.
        ssi:
          type: object
          properties:
            enabled:
              type: boolean
              title: Is enabled
              description: Whether SSI include is enabled.
          required:
          - enabled
          additionalProperties: false
          title: SSI configuration
          description: Server-Side Include configuration.
        upstream:
          type: string
          title: Upstream
          description: The upstream to use for this route.
        redirects:
          type: object
          properties:
            expires:
              type: string
              title: Expires
              description: The amount of time, in seconds, to cache the redirects.
            paths:
              type: object
              additionalProperties:
                type: object
                properties:
                  regexp:
                    type: boolean
                    title: Is regexp
                    description: Whether the path is a regular expression.
                  to:
                    type: string
                    title: Redirect URL
                    description: The URL to redirect to.
                  prefix:
                    type:
                    - boolean
                    - 'null'
                    title: Is prefix
                    description: Whether to redirect all the paths that start with the path.
                  append_suffix:
                    type:
                    - boolean
                    - 'null'
                    title: Append suffix
                    description: Whether to append the incoming suffix to the redirected URL.
                  code:
                    type: integer
                    enum:
                    - 301
                    - 302
                    - 307
                    - 308
                    title: Redirect code
                    description: The redirect code to use.
                  expires:
                    type:
                    - string
                    - 'null'
                    title: Expires
                    description: The amount of time, in seconds, to cache the redirects.
                required:
                - regexp
                - to
                - prefix
                - append_suffix
                - code
                - expires
                additionalProperties: false
              title: Path
              description: The paths to redirect
          required:
          - expires
          - paths
          additionalProperties: false
          title: Redirect configuration
          description: The configuration of the redirects.
        sticky:
          type: object
          properties:
            enabled:
              type: boolean
              title: Is enabled
              description: Whether sticky routing is enabled.
          required:
          - enabled
          additionalProperties: false
          title: Sticky configuration
          description: Sticky routing configuration.
      required:
      - primary
      - id
      - production_url
      - attributes
      - type
      - tls
      - cache
      - ssi
      - upstream
      - redirects
      - sticky
      additionalProperties: false
    Deployment:
      type: object
      properties:
        id:
          type: string
          title: Deployment Identifier
          description: The identifier of Deployment
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          title: Creation date
          description: The creation date of the deployment
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          title: Update date
          description: The update date of the deployment
        fingerprint:
          type: string
          title: Deployment fingerprint
          description: The fingerprint of the deployment
        cluster_name:
          type: string
          title: Cluster name
          description: The name of the cluster
        project_info:
          type: object
          properties:
            title:
              type: string
              title: Title
              description: ''
            name:
              type: string
              title: Name
              description: ''
            namespace:
              type:
              - string
              - 'null'
              title: Namespace
              description: ''
            organization:
              type:
              - string
              - 'null'
              title: Organization
              description: ''
            capabilities:
              type: object
              title: Capabilities
              description: ''
            settings:
              type: object
              title: Settings
              description: ''
          required:
          - title
          - name
          - namespace
          - organization
          - capabilities
          - settings
          additionalProperties: false
          title: Project info
          description: The project information
        environment_info:
          type: object
          properties:
            name:
              type: string
              title: Environment name
              description: The machine name of the environment
            status:
              type: string
              title: Environment status
              description: The enviroment status
            is_main:
              type: boolean
              title: Is main environment
              description: Is this environment the main environment
            is_production:
              type: boolean
              title: Is production environment
              description: Is this environment a production environment
            constraints:
              type: object
              title: Environment constraints
              description: Constraints of the environment's deployment
            reference:
              type: string
              title: Git reference
              description: The reference in Git for this environment
            machine_name:
              type: string
              title: Machine name
              description: The machine name of the environment
            environment_type:
              type: string
              title: Environment type
              description: The type of environment (Production, Staging or Development)
            links:
              type: object
              title: Links
              description: ''
          required:
          - name
          - status
          - is_main
          - is_production
          - constraints
          - reference
          - machine_name
          - environment_type
          - links
          additionalProperties: false
          title: Environment info
          description: The environment information
        deployment_target:
          type: string
          title: Deployment target
          description: The deployment target
        vpn:
          type:
          - object
          - 'null'
          properties:
            version:
              type: integer
              enum:
              - 1
              - 2
              title: IKE Version
              description: The IKE version to use (1 or 2)
            aggressive:
              type: string
              enum:
              - 'no'
              - 'yes'
              title: Aggressive Mode
              description: Whether to use IKEv1 Aggressive or Main Mode
            modeconfig:
              type: string
              enum:
              - pull
              - push
              title: Mode Config
              description: Defines which mode is used to assign a virtual IP (must be the same on both sides)
            authentication:
              type: string
              title: Authentication scheme
              description: The authentication scheme
            gateway_ip:
              type: string
              title: Remote gateway IP
              description: ''
            identity:
              type:
              - string
              - 'null'
              title: Identity
              description: The identity of the ipsec participant
            second_identity:
              type:
              - string
              - 'null'
              title: Second Identity
              description: The second identity of the ipsec participant
            remote_identity:
              type:
              - string
              - 'null'
              title: Remote Identity
              description: The identity of the remote ipsec participant
            remote_subnets:
              type: array
              items:
                type: string
              title: Remote Subnets
              description: Remote subnets (CIDR notation)
            ike:
              type: string
              title: IKE algorithms
              description: The IKE algorithms to negotiate for this VPN connection.
            esp:
              type: string
              title: ESP algorithms
              description: The ESP algorithms to negotiate for this VPN connection.
            ikelifetime:
              type: string
              title: IKE Lifetime
              description: The lifetime of the IKE exchange.
            lifetime:
              type: string
              title: ESP Lifetime
              description: The lifetime of the ESP exchange.
            margintime:
              type: string
              title: Margin Time
              description: The margin time for re-keying.
          required:
          - version
          - aggressive
          - modeconfig
          - authentication
          - gateway_ip
          - identity
          - second_identity
          - remote_identity
          - remote_subnets
          - ike
          - esp
          - ikelifetime
          - lifetime
          - margintime
          additionalProperties: false
          title: VPN configuration
          description: The configuration of the VPN
        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 permissions of the HTTP access
        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
        variables:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                title: Variable name
                description: Name of the variable
              value:
                type: string
                title: Variable value
                description: Value of the variable
              is_sensitive:
                type: boolean
                title: Is sensitive
                description: The variable is sensitive
              is_json:
                type: boolean
                title: Is JSON
                description: The variable is a JSON string
              visible_build:
                type: boolean
                title: Visible at build time
                description: The variable is visible during build
              visible_runtime:
                type: boolean
                title: Visible at runtime
                description: The variable is visible at runtime
            required:
            - name
            - is_sensitive
            - is_json
            - visible_build
            - visible_runtime
            additionalProperties: false
          title: Environment variables
          description: The variables applying to this environment
        access:
          type: array
          items:
            type: object
            properties:
              entity_id:
                type: string
                title: Entity ID
                description: ''
              role:
                type: string
                enum:
                - admin
                - contributor
                - viewer
                title: Role
                description: ''
            required:
            - entity_id
            - role
            additionalProperties: false
          title: Access control
          description: Access control definition for this enviroment
        subscription:
          type: object
          properties:
            license_uri:
              type: string
              title: Subscription URI
              description: URI of the subscription
            plan:
              type: string
              enum:
              - 2xlarge
              - 2xlarge-high-memory
              - 4xlarge
              - 8xlarge
              - development
              - large
              - large-high-memory
              - medium
              - medium-high-memory
              - standard
              - standard-high-memory
              - xlarge
              - xlarge-high-memory
              title: Plan level
              description: ''
            environments:
              type: integer
              title: Environments number
              description: Number of environments
            storage:
              type: integer
              title: Storage
              description: Size of storage (in MB)
            included_users:
              type: integer
              title: Included users
              description: Number of users
            subscription_management_uri:
              type: string
              title: Subscription management URI
              description: URI for managing the subscription
            restricted:
              type: boolean
              title: Is subscription attributes frozen
              description: True if subscription attributes, like number of users, are frozen
            suspended:
              type: boolean
              title: Is subscription suspended
              description: Whether or not the subscription is suspended
            user_licenses:
              type: integer
              title: Current number of users
              description: Current number of users
            resources:
              type: object
      

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