Release

Release Deploys API

The Deploys API from Release — 5 operation(s) for deploys.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.release.com/reference-documentation/release-api.md
📖
APIReference
https://docs.release.com/reference-documentation/release-api/platform-api.md

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/release/refs/heads/main/openapi/release-deploys-api-openapi.yml

Other Resources

🔗
GraphQL
https://docs.release.com/reference-documentation/release-api/graphql-api.md

OpenAPI Specification

release-deploys-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Release.com Platform Accounts Deploys API
  version: 1.0.0
  description: 'The Release.com Platform API provides REST endpoints for managing

    ephemeral environments, deployments, builds, clusters, and related

    infrastructure.


    **V1 scope:** Platform endpoints only. AI sandbox endpoints (`/ai/**`)

    are excluded from this version and will be added in a future iteration.

    '
  contact:
    name: Release.com
    url: https://release.com
  x-logo:
    url: https://api.release.com/release-logo.png
    backgroundColor: '#FFFFFF'
    altText: Release
servers:
- url: https://api.release.com
  description: Production
security:
- userEmail: []
  userToken: []
tags:
- name: Deploys
paths:
  /apps/{app_id}/spaces/{space_id}/pipelines/{id}/abort:
    put:
      tags:
      - Deploys
      summary: Abort deploy
      operationId: pipelines_abort
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'
        '401':
          description: Unauthorized — missing or invalid credentials
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          type: string
        description: App ID (integer or hashid)
      - name: space_id
        in: path
        required: true
        schema:
          type: string
        description: Environment ID (integer or hashid)
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Resource ID (integer or hashid)
  /apps/{app_id}/spaces/{space_id}/pipelines:
    get:
      tags:
      - Deploys
      summary: List Pipelines
      operationId: pipelines_index
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Pipeline'
        '401':
          description: Unauthorized — missing or invalid credentials
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          type: string
        description: App ID (integer or hashid)
      - name: space_id
        in: path
        required: true
        schema:
          type: string
        description: Environment ID (integer or hashid)
    post:
      tags:
      - Deploys
      summary: Create Pipeline
      operationId: pipelines_create
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized — missing or invalid credentials
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          type: string
        description: App ID (integer or hashid)
      - name: space_id
        in: path
        required: true
        schema:
          type: string
        description: Environment ID (integer or hashid)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
  /apps/{app_id}/spaces/{space_id}/pipelines/{id}:
    get:
      tags:
      - Deploys
      summary: Get Pipeline
      operationId: pipelines_show
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'
        '401':
          description: Unauthorized — missing or invalid credentials
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          type: string
        description: App ID (integer or hashid)
      - name: space_id
        in: path
        required: true
        schema:
          type: string
        description: Environment ID (integer or hashid)
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Resource ID (integer or hashid)
  /apps/{app_id}/pipelines:
    get:
      tags:
      - Deploys
      summary: List Pipelines
      operationId: pipelines_get_index
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Pipeline'
        '401':
          description: Unauthorized — missing or invalid credentials
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          type: string
        description: App ID (integer or hashid)
  /apps/{app_id}/pipelines/{id}:
    get:
      tags:
      - Deploys
      summary: Get Pipeline
      operationId: pipelines_get_show
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'
        '401':
          description: Unauthorized — missing or invalid credentials
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          type: string
        description: App ID (integer or hashid)
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Resource ID (integer or hashid)
components:
  schemas:
    Pipeline:
      type: object
      properties:
        id:
          type: integer
        aasm_state:
          type: string
        status_reason:
          type: string
        started_at:
          type: string
        total_duration:
          type: number
        error_message:
          type: string
        name:
          type: string
        commit_long:
          type: string
        commit_short:
          type: string
        commit_date:
          type: string
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        errors:
          type: array
          items:
            type: string
  securitySchemes:
    userEmail:
      type: apiKey
      in: header
      name: X-User-Email
      description: User's email address for authentication
    userToken:
      type: apiKey
      in: header
      name: X-User-Token
      description: User's authentication token (from ~/.release.yaml)
externalDocs:
  description: Release Documentation
  url: https://docs.release.com