Upsun Organization Projects API

openapi: 3.2.0
info:
  title: Upsun.com Rest Organization Projects 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.'
  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:
- OAuth2: []
tags:
- name: Organization Projects
paths:
  /organizations/{organization_id}/projects:
    get:
      summary: List projects
      description: Retrieves a list of projects for the specified organization.
      operationId: list-org-projects
      tags:
      - Organization Projects
      parameters:
      - $ref: '#/components/parameters/OrganizationID'
      - in: query
        name: filter[id]
        description: Allows filtering by `id` using one or more operators.
        style: deepObject
        explode: true
        schema:
          $ref: '#/components/schemas/StringFilter'
      - in: query
        name: filter[title]
        description: Allows filtering by `title` using one or more operators.
        style: deepObject
        explode: true
        schema:
          $ref: '#/components/schemas/StringFilter'
      - in: query
        name: filter[status]
        description: Allows filtering by `status` using one or more operators.
        style: deepObject
        explode: true
        schema:
          $ref: '#/components/schemas/StringFilter'
      - in: query
        name: filter[updated_at]
        description: Allows filtering by `updated_at` using one or more operators.
        style: deepObject
        explode: true
        schema:
          $ref: '#/components/schemas/DateTimeFilter'
      - in: query
        name: filter[created_at]
        description: Allows filtering by `created_at` using one or more operators.
        style: deepObject
        explode: true
        schema:
          $ref: '#/components/schemas/DateTimeFilter'
      - in: query
        name: page[size]
        description: Determines the number of items to show.
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: null
      - in: query
        name: page[before]
        description: Pagination cursor. This is automatically generated as necessary and provided in HAL links (_links); it should not be constructed externally.
        schema:
          type: string
      - in: query
        name: page[after]
        description: Pagination cursor. This is automatically generated as necessary and provided in HAL links (_links); it should not be constructed externally.
        schema:
          type: string
      - in: query
        name: sort
        description: 'Allows sorting by a single field.<br>

          Use a dash ("-") to sort descending.<br>

          Supported fields: `id`, `region`, `title`, `type`, `plan`, `status`, `created_at`, `updated_at`.

          '
        schema:
          type: string
          example: -updated_at
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/OrganizationProject'
                  _links:
                    $ref: '#/components/schemas/ListLinks'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      summary: Create project
      description: Creates a new project in the specified organization.
      operationId: create-org-project
      tags:
      - Organization Projects
      parameters:
      - $ref: '#/components/parameters/OrganizationID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - region
              properties:
                organization_id:
                  $ref: '#/components/schemas/OrganizationID'
                region:
                  $ref: '#/components/schemas/RegionID'
                title:
                  $ref: '#/components/schemas/ProjectTitle'
                type:
                  $ref: '#/components/schemas/ProjectType'
                plan:
                  $ref: '#/components/schemas/ProjectPlan'
                default_branch:
                  $ref: '#/components/schemas/ProjectDefaultBranch'
                cse_notes:
                  $ref: '#/components/schemas/ProjectCSENotes'
                dedicated_tag:
                  $ref: '#/components/schemas/ProjectDedicatedTag'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationProject'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
  /organizations/{organization_id}/projects/{project_id}:
    get:
      summary: Get project
      description: Retrieves the specified project.
      operationId: get-org-project
      tags:
      - Organization Projects
      parameters:
      - $ref: '#/components/parameters/OrganizationID'
      - $ref: '#/components/parameters/ProjectID'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationProject'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
    patch:
      summary: Update project
      description: Updates the specified project.
      operationId: update-org-project
      tags:
      - Organization Projects
      parameters:
      - $ref: '#/components/parameters/OrganizationID'
      - $ref: '#/components/parameters/ProjectID'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  $ref: '#/components/schemas/ProjectTitle'
                plan:
                  $ref: '#/components/schemas/ProjectPlan'
                timezone:
                  $ref: '#/components/schemas/ProjectTimeZone'
                cse_notes:
                  $ref: '#/components/schemas/ProjectCSENotes'
                dedicated_tag:
                  $ref: '#/components/schemas/ProjectDedicatedTag'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationProject'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      summary: Delete project
      description: Deletes the specified project.
      operationId: delete-org-project
      tags:
      - Organization Projects
      parameters:
      - $ref: '#/components/parameters/OrganizationID'
      - $ref: '#/components/parameters/ProjectID'
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
  /organizations/{organization_id}/projects/{project_id}/metrics/carbon:
    get:
      summary: Query project carbon emissions metrics
      description: Queries the carbon emission data for the specified project using the supplied parameters.
      operationId: query-project-carbon
      tags:
      - Organization Projects
      parameters:
      - $ref: '#/components/parameters/OrganizationID'
      - $ref: '#/components/parameters/ProjectID'
      - $ref: '#/components/parameters/from'
      - $ref: '#/components/parameters/to'
      - $ref: '#/components/parameters/interval'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectCarbon'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    DateTimeFilter:
      type: object
      properties:
        eq:
          type: string
          description: Equal
        ne:
          type: string
          description: Not equal
        between:
          type: string
          description: Between (comma-separated list)
        gt:
          type: string
          description: Greater than
        gte:
          type: string
          description: Greater than or equal
        lt:
          type: string
          description: Less than
        lte:
          type: string
          description: Less than or equal
    ProjectCarbon:
      type: object
      properties:
        project_id:
          $ref: '#/components/schemas/ProjectID'
        project_title:
          $ref: '#/components/schemas/ProjectTitle'
        meta:
          $ref: '#/components/schemas/MetricsMetadata'
        values:
          $ref: '#/components/schemas/MetricsValues'
        total:
          $ref: '#/components/schemas/CarbonTotal'
    Error:
      description: ''
      type: object
      properties:
        status:
          type: string
        message:
          type: string
        code:
          type: number
        detail:
          type: object
        title:
          type: string
      title: ''
      x-examples:
        example-1:
          status: Invalid input
          message: This field is required.
          code: 400
          detail:
            field:
            - This field is required.
          title: Bad Request
    ProjectLocked:
      type: boolean
      description: Locked
    ProjectID:
      type: string
      description: The ID of the project.
    ProjectStatus:
      type: string
      description: The status of the project.
      enum:
      - requested
      - active
      - failed
      - suspended
      - deleted
    ProjectType:
      type: string
      description: The type of projects.
      enum:
      - grid
      - dedicated
    UpdatedAt:
      type: string
      format: date-time
      description: The date and time when the resource was last updated.
    ProjectTimeZone:
      type: string
      description: Timezone of the project.
    CarbonTotal:
      type: number
      description: The calculated total of the metric for the given interval.
    MetricsMetadata:
      type: object
      properties:
        from:
          description: The value used to calculate the lower bound of the temporal query. Inclusive.
        to:
          description: The truncated value used to calculate the upper bound of the temporal query. Exclusive.
        interval:
          description: The interval used to group the metric values.
        units:
          description: The units associated with the provided values.
    MetricsValue:
      type: object
      properties:
        value:
          description: The measured value of the metric for the given time interval.
        start_time:
          description: The timestamp at which the time interval began.
    ProjectTrialPlan:
      description: Whether the project is currently on a trial plan.
      type: boolean
    ProjectDefaultBranch:
      type: string
      description: Default branch.
    ProjectPlan:
      type: string
      description: The project plan.
    OrganizationID:
      type: string
      description: The ID of the organization.
    Link:
      type: object
      title: Link
      description: A hypermedia link to the {current, next, previous} set of items.
      properties:
        href:
          type: string
          description: URL of the link
    ListLinks:
      type: object
      properties:
        self:
          $ref: '#/components/schemas/Link'
        previous:
          $ref: '#/components/schemas/Link'
        next:
          $ref: '#/components/schemas/Link'
    ProjectUI:
      description: The URL for the project's user interface.
      type: string
    OrganizationProject:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ProjectID'
        organization_id:
          $ref: '#/components/schemas/OrganizationID'
        subscription_id:
          $ref: '#/components/schemas/SubscriptionID'
        vendor:
          type: string
          description: Vendor of the project.
        region:
          $ref: '#/components/schemas/RegionID'
        title:
          $ref: '#/components/schemas/ProjectTitle'
        type:
          $ref: '#/components/schemas/ProjectType'
        plan:
          $ref: '#/components/schemas/ProjectPlan'
        timezone:
          $ref: '#/components/schemas/ProjectTimeZone'
        default_branch:
          $ref: '#/components/schemas/ProjectDefaultBranch'
        status:
          $ref: '#/components/schemas/ProjectStatus'
        trial_plan:
          $ref: '#/components/schemas/ProjectTrialPlan'
        project_ui:
          $ref: '#/components/schemas/ProjectUI'
        locked:
          $ref: '#/components/schemas/ProjectLocked'
        cse_notes:
          $ref: '#/components/schemas/ProjectCSENotes'
        dedicated_tag:
          $ref: '#/components/schemas/ProjectDedicatedTag'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        _links:
          type: object
          properties:
            self:
              type: object
              description: Link to the current project.
              properties:
                href:
                  type: string
                  description: URL of the link.
            update:
              type: object
              description: Link for updating the current project.
              properties:
                href:
                  type: string
                  description: URL of the link.
                method:
                  type: string
                  description: The HTTP method to use.
            delete:
              type: object
              description: Link for deleting the current project.
              properties:
                href:
                  type: string
                  description: URL of the link.
                method:
                  type: string
                  description: The HTTP method to use.
            activities:
              type: object
              description: Link to the project's activities.
              properties:
                href:
                  type: string
                  description: URL of the link.
            addons:
              type: object
              description: Link to the project's add-ons.
              properties:
                href:
                  type: string
                  description: URL of the link.
    CreatedAt:
      type: string
      format: date-time
      description: The date and time when the resource was created.
    ProjectDedicatedTag:
      type: string
      description: Dedicated tag.
    ProjectCSENotes:
      type: string
      description: CSE notes.
    StringFilter:
      type: object
      properties:
        eq:
          type: string
          description: Equal
        ne:
          type: string
          description: Not equal
        in:
          type: string
          description: In (comma-separated list)
        nin:
          type: string
          description: Not in (comma-separated list)
        between:
          type: string
          description: Between (comma-separated list)
        contains:
          type: string
          description: Contains
        starts:
          type: string
          description: Starts with
        ends:
          type: string
          description: Ends with
    ProjectTitle:
      type: string
      description: The title of the project.
    RegionID:
      type: string
      description: The machine name of the region where the project is located.
    MetricsValues:
      type: array
      items:
        $ref: '#/components/schemas/MetricsValue'
    SubscriptionID:
      type: string
      description: The ID of the subscription.
  parameters:
    from:
      in: query
      name: from
      description: The start of the time frame for the query. Inclusive.
      schema:
        $ref: '#/components/schemas/DateTimeFilter'
    ProjectID:
      name: project_id
      in: path
      required: true
      description: The ID of the project.
      schema:
        type: string
    interval:
      in: query
      name: interval
      description: The interval by which the query groups the results. of the time frame for the query. Exclusive.
      schema:
        type: string
        enum:
        - day
        - month
        - year
    OrganizationID:
      name: organization_id
      in: path
      required: true
      description: The ID of the organization.
      schema:
        type: string
        format: ulid
    to:
      in: query
      name: to
      description: The end of the time frame for the query. Exclusive.
      schema:
        $ref: '#/components/schemas/DateTimeFilter'
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          tokenUrl: https://auth.api.platform.sh/oauth2/token
          refreshUrl: https://auth.api.platform.sh/oauth2/token
          scopes: {}
          authorizationUrl: https://auth.api.platform.sh/oauth2/authorize
      description: ''
    OAuth2Admin:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.api.platform.sh/oauth2/token
          refreshUrl: ''
          scopes:
            admin: administrative operations
      description: ''
x-tagGroups:
- name: Organization Administration
  tags:
  - Organizations
  - Organization Members
  - Organization Invitations
  - Organization Projects
  - Add-ons
- name: Project Administration
  tags:
  - Project
  - Domain Management
  - Cert Management
  - Certificate Provisioner
  - Project Variables
  - Repository
  - Third-Party Integrations
  - Support
- name: Environments
  tags:
  - Environment
  - Environment Backups
  - Environment Type
  - Environment Variables
  - Routing
  - Source Operations
  - Runtime Operations
  - Deployment
  - Autoscaling
- name: User Activity
  tags:
  - Project Activity
  - Environment Activity
- name: Project Access
  tags:
  - Project Invitations
  - Teams
  - Team Access
  - User Access
- name: Account Management
  tags:
  - API Tokens
  - Connections
  - MFA
  - Users
  - User Profiles
  - SSH Keys
  - Plans
- name: Billing
  tags:
  - Organization Management
  - Subscriptions
  - Orders
  - Invoices
  - Discounts
  - Vouchers
  - Records
  - Profiles
- name: Global Info
  tags:
  - Project Discovery
  - References
  - Regions
- name: Internal APIs
  tags:
  - Project Settings
  - Environment Settings
  - Deployment Target
  - System Information
  - Container Profile