> ## Documentation Index
> Fetch the complete documentation index at: https://docs.upsolve.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Version Publish Status

> Get the publish status of a version



## OpenAPI

````yaml get /v2/api/projects/{projectId}/workspaces/{workspaceId}/versions/{version}/publish-status
openapi: 3.1.0
info:
  title: Upsolve API
  version: 1.5.0
servers:
  - url: https://api.upsolve.ai
security: []
tags: []
paths:
  /v2/api/projects/{projectId}/workspaces/{workspaceId}/versions/{version}/publish-status:
    get:
      summary: Get the publish status of a version
      description: Get the publish status of a version
      operationId: >-
        GetV2ApiProjectsProjectIdWorkspacesWorkspaceIdVersionsVersionPublishStatus
      parameters:
        - name: apiKey
          in: query
          required: false
          description: >-
            Upsolve API key, generated under Account → Developer settings in the
            Upsolve Hub. Keys are user-scoped: pass organizationId alongside the
            key to select which org to act on.
          schema:
            type: string
            minLength: 1
            description: >-
              Upsolve API key, generated under Account → Developer settings in
              the Upsolve Hub. Keys are user-scoped: pass organizationId
              alongside the key to select which org to act on.
            examples:
              - up_embed_************
          examples:
            example1:
              value: up_embed_************
        - name: organizationId
          in: query
          required: false
          description: >-
            Your Upsolve organization's UUID — the org that owns the API key and
            project. This is NOT a project organization: do not pass a value
            registered via /projects/register-organization, and do not pass an
            `externalId` (only `projectOrganizationId` accepts those). Omit it
            when using an org-bound API key — the org is read from the key and
            any value sent here is ignored. Required only for user-scoped API
            keys (created under Account → Developer settings) and for the
            Supabase JWT path, where the org is ambiguous and membership is
            verified against it.
          schema:
            description: >-
              Your Upsolve organization's UUID — the org that owns the API key
              and project. This is NOT a project organization: do not pass a
              value registered via /projects/register-organization, and do not
              pass an `externalId` (only `projectOrganizationId` accepts those).
              Omit it when using an org-bound API key — the org is read from the
              key and any value sent here is ignored. Required only for
              user-scoped API keys (created under Account → Developer settings)
              and for the Supabase JWT path, where the org is ambiguous and
              membership is verified against it.
            examples:
              - 123e4567-e89b-12d3-a456-426614174000
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
          examples:
            example1:
              value: 123e4567-e89b-12d3-a456-426614174000
        - name: projectId
          in: path
          required: true
          description: >-
            GET
            /v2/api/projects/:projectId/workspaces/:workspaceId/versions/:version/publish-status
            Parameter
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
        - name: workspaceId
          in: path
          required: true
          description: >-
            GET
            /v2/api/projects/:projectId/workspaces/:workspaceId/versions/:version/publish-status
            Parameter
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
        - name: version
          in: path
          required: true
          description: >-
            GET
            /v2/api/projects/:projectId/workspaces/:workspaceId/versions/:version/publish-status
            Parameter
          schema:
            type: integer
            minimum: 1
            maximum: 9007199254740991
      responses:
        '200':
          description: >-
            GET
            /v2/api/projects/:projectId/workspaces/:workspaceId/versions/:version/publish-status
            Positive response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: success
                  data:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - publishing
                          - published
                          - failed
                      startedAt:
                        type:
                          - string
                          - 'null'
                      finishedAt:
                        type:
                          - string
                          - 'null'
                      error:
                        type:
                          - string
                          - 'null'
                      steps:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              enum:
                                - test-cases
                                - rls
                              description: >-
                                The checks, and only the checks. The
                                knowledge-base rebuild a publish performs is not
                                a step — it cannot refuse a publish — and its
                                progress is reported through the status `error`
                                line instead. A stored step naming a retired key
                                is dropped on the read, so this enum stays
                                closed.
                            label:
                              type: string
                              description: What the modal shows. Written by the server.
                            status:
                              type: string
                              enum:
                                - pending
                                - running
                                - passed
                                - failed
                                - skipped
                                - unavailable
                              description: >-
                                `skipped` and `unavailable` are real outcomes,
                                not missing ones, and they differ in their
                                remedy. `skipped` means the step could have run
                                and did not — an earlier step failed, or the
                                attempt was stopped — so retrying may clear it.
                                `unavailable` means the organization's plan does
                                not include what the step checks, so nothing a
                                builder does to this draft will change it.
                            detail:
                              type:
                                - string
                                - 'null'
                            startedAt:
                              type:
                                - string
                                - 'null'
                            finishedAt:
                              type:
                                - string
                                - 'null'
                            testRunJobId:
                              type:
                                - string
                                - 'null'
                          required:
                            - key
                            - label
                            - status
                            - detail
                            - startedAt
                            - finishedAt
                            - testRunJobId
                          additionalProperties: false
                    required:
                      - status
                      - startedAt
                      - finishedAt
                      - error
                      - steps
                    additionalProperties: false
                required:
                  - status
                  - data
                additionalProperties: false
        '400':
          description: >-
            GET
            /v2/api/projects/:projectId/workspaces/:workspaceId/versions/:version/publish-status
            Negative response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: error
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      code:
                        type: string
                      details:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                    required:
                      - message
                    additionalProperties: false
                required:
                  - status
                  - error
                additionalProperties: false
      security:
        - APIKEY_2: []
components:
  securitySchemes:
    APIKEY_2:
      type: apiKey
      in: query
      name: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.