Hlix Deployments API

openapi: 3.2.0
info:
  description: Explore the Hlix API for projects, agent teams, and delivery workflows. Authenticate with `x-api-key` and select a Workspace with `X-Organization-Id`. Session-only operations require a signed-in user session. Authentication setup.
  title: reference Deployments API
  version: 1.0.0
servers:
- url: https://server.hlix.ai
  description: API server
security:
- apiKey: []
- sessionCookie: []
tags:
- name: Deployments
paths:
  /v1/api/deployments:
    get:
      operationId: listDeployments
      parameters:
      - description: Only this project's deployments.
        in: query
        name: projectId
        required: false
        schema:
          type: string
      - description: '`project` (canonical preview), `cycle-preview` or `production`. Unrecognized values are ignored and leave the list unfiltered.'
        in: query
        name: kind
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      - $ref: '#/components/parameters/ClientPortal'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Deployment'
                type: array
          description: Matching deployments, oldest first.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: List deployments
      tags:
      - Deployments
    post:
      operationId: redeployProjectPreview
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RedeployPreview'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentAccepted'
          description: Handed to the pipeline. The row moves through `building` → `deploying` → `live` on its own; poll `GET /deployments/{id}`.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: The JSON body failed validation — `projectId` is required — or the request named no active organization. Validation runs as middleware, so a malformed payload is answered 400 even when previews are switched off.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such project, or no such repository on it.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentRepoAmbiguous'
          description: The project is archived, or it builds against several repositories and names no primary. Unarchive it or retry with `repoId` — `repos` is present only in the second case.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Preview deployments are switched off for this deployment of hlix.
      summary: Redeploy a project's preview, or deploy it to production
      tags:
      - Deployments
  /v1/api/deployments/custom-domain:
    get:
      operationId: getProductionCustomDomain
      parameters:
      - description: The project whose custom domain to check.
        in: query
        name: projectId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      - $ref: '#/components/parameters/ClientPortal'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomainStatus'
          description: 'The domain''s state, or `domain: null` when none is set.'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: projectId is missing.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such project.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Custom domains are unavailable or the check failed.
      summary: Check the production deployment's custom domain
      tags:
      - Deployments
    put:
      operationId: setProductionCustomDomain
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomDomain'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDomainStatus'
          description: Connected (with the DNS records to add) or removed.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: The body failed validation, or the domain is an hlix address.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such project.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Another project already holds this domain.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Custom domains are unavailable or the zone call failed.
      summary: Connect or remove the production deployment's custom domain
      tags:
      - Deployments
  /v1/api/deployments/preview-sharing:
    get:
      operationId: getPreviewSharing
      parameters:
      - description: The project whose preview sharing to read.
        in: query
        name: projectId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      - $ref: '#/components/parameters/ClientPortal'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewSharingSaved'
          description: Whether anyone with a preview link can open it.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: projectId is required.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such project.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Sharing storage is unavailable.
      summary: Get public preview sharing for a project
      tags:
      - Deployments
    put:
      operationId: setPreviewSharing
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewSharing'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewSharingSaved'
          description: Sharing applies to all retained and future previews. Agency only.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: The body failed validation.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Clients cannot change sharing.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such project.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Sharing could not be changed.
      summary: Enable or revoke public preview sharing
      tags:
      - Deployments
  /v1/api/deployments/{id}:
    get:
      operationId: getDeployment
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      - $ref: '#/components/parameters/ClientPortal'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
          description: The deployment row.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such deployment in this workspace.
      summary: Get one deployment
      tags:
      - Deployments
  /v1/api/deployments/{id}/touch:
    post:
      operationId: touchDeployment
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      - $ref: '#/components/parameters/ClientPortal'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentTouched'
          description: The TTL was extended. A project's canonical preview has no TTL, and touching it changes nothing.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such deployment in this workspace.
      summary: Extend a preview's time to live
      tags:
      - Deployments
components:
  schemas:
    ApiError:
      additionalProperties: {}
      properties:
        error:
          type: string
      required:
      - error
      type: object
    CustomDomain:
      properties:
        domain:
          anyOf:
          - maxLength: 253
            pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$
            type: string
          - type: 'null'
        projectId:
          minLength: 1
          type: string
      required:
      - projectId
      - domain
      type: object
    RedeployPreview:
      properties:
        kind:
          enum:
          - project
          - production
          type: string
        minInstances:
          anyOf:
          - const: 0
            type: number
          - const: 1
            type: number
        projectId:
          minLength: 1
          type: string
        repoId:
          minLength: 1
          type: string
      required:
      - projectId
      type: object
    DeploymentAccepted:
      properties:
        accepted:
          const: true
          type: boolean
        kind:
          enum:
          - project
          - production
          type: string
        repo:
          properties:
            id:
              type: string
            isPrimary:
              type: boolean
            label:
              type:
              - string
              - 'null'
            name:
              type: string
            owner:
              type: string
          required:
          - id
          - owner
          - name
          - label
          - isPrimary
          type: object
        selectedBy:
          enum:
          - explicit
          - only
          - primary
          type: string
      required:
      - accepted
      - repo
      - selectedBy
      - kind
      type: object
    DeploymentRepoAmbiguous:
      properties:
        error:
          type: string
        repos:
          items:
            properties:
              id:
                type: string
              name:
                type: string
              owner:
                type: string
            required:
            - id
            - owner
            - name
            type: object
          type: array
      required:
      - error
      type: object
    PreviewSharingSaved:
      properties:
        public:
          type: boolean
      required:
      - public
      type: object
    DeploymentTouched:
      properties:
        touched:
          const: true
          type: boolean
      required:
      - touched
      type: object
    PreviewSharing:
      properties:
        projectId:
          minLength: 1
          type: string
        public:
          type: boolean
      required:
      - projectId
      - public
      type: object
    ValidationError:
      properties:
        error:
          properties:
            message:
              type: string
            name:
              type: string
          required:
          - name
          - message
          type: object
        success:
          const: false
          type: boolean
      required:
      - success
      - error
      type: object
    CustomDomainStatus:
      properties:
        domain:
          type:
          - string
          - 'null'
        errors:
          items:
            type: string
          type: array
        records:
          items:
            properties:
              name:
                type: string
              type:
                enum:
                - CNAME
                - TXT
                type: string
              value:
                type: string
            required:
            - type
            - name
            - value
            type: object
          type: array
        state:
          enum:
          - pending
          - issuing
          - active
          - failed
          type: string
      required:
      - domain
      type: object
    Deployment:
      properties:
        buildId:
          type:
          - string
          - 'null'
        createdAt:
          type: string
        cycleId:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        expiresAt:
          type:
          - string
          - 'null'
        gitBranch:
          type:
          - string
          - 'null'
        gitSha:
          type:
          - string
          - 'null'
        id:
          type: string
        imageUri:
          type:
          - string
          - 'null'
        kind:
          type: string
        lastAccessedAt:
          type:
          - string
          - 'null'
        organizationId:
          type: string
        projectId:
          type: string
        region:
          type: string
        revision:
          type:
          - string
          - 'null'
        serviceName:
          type: string
        slug:
          type: string
        status:
          type: string
        updatedAt:
          type: string
        url:
          type:
          - string
          - 'null'
      required:
      - id
      - organizationId
      - projectId
      - cycleId
      - kind
      - gitBranch
      - gitSha
      - region
      - serviceName
      - imageUri
      - revision
      - buildId
      - slug
      - url
      - status
      - errorMessage
      - expiresAt
      - lastAccessedAt
      - createdAt
      - updatedAt
      type: object
  parameters:
    ClientPortal:
      description: The agency Workspace ID for a signed-in client's portal requests. A verified user session and portal membership are required; API keys cannot authenticate portal access. This header does not grant agency administration access.
      in: header
      name: X-Client-Portal
      required: false
      schema:
        type: string
    OrganizationId:
      description: The workspace (organization) to act in. Omitted, the session's active organization is used.
      in: header
      name: X-Organization-Id
      required: false
      schema:
        type: string
      example: YOUR_WORKSPACE_ID
  securitySchemes:
    apiKey:
      description: An API key issued through `/v1/api/auth/api-key/*`. Browser clients can use their session cookie instead.
      in: header
      name: x-api-key
      type: apiKey
    sessionCookie:
      description: The complete session Cookie header issued by sign-in at the selected API host. Cookie names vary by hosting region and environment; preserve the issued name and value. Browsers send these HTTP-only cookies automatically. Session-only operations require this user session and do not accept an API key.
      in: header
      name: Cookie
      type: apiKey