> ## Documentation index
> Fetch the complete documentation index at: https://context7.com/docs/llms.txt
> Ask it with GET https://context7.com/docs/ask?q=<keywords or question>. Short keywords rank best.
> Use these to discover all available pages before exploring further.
> Feature requests: https://context7.com/docs/resources/feature-requests.md lists what users asked for and how to vote for a request or add one.
> Page rating: `GET https://context7.com/docs/feedback?path=/docs/api-reference/docs7-sites/get-a-deployment&helpful=true` (or `false`) records whether this page helped. An optional `comment` (URL-encoded, at most 500 characters) says what was missing or wrong. It is anonymous and needs no key. Comments hold no code, secrets or personal data.

# Get a deployment

> One build. Any member. Only for GitHub sites: a CLI site (`source: "local"`) answers 404.

`GET /v2/teamspaces/{teamspaceId}/sites/{siteId}/deployments/{deploymentId}`

## OpenAPI

````yaml https://context7.com/openapi.json get /v2/teamspaces/{teamspaceId}/sites/{siteId}/deployments/{deploymentId}
openapi: 3.0.0
info:
  title: Context7 Public API
  description: The Context7 Public API provides programmatic access to library
    documentation and search functionality. Get up-to-date documentation and
    code examples for any library.
  version: 2.0.0
  contact:
    name: Context7 Support
    url: https://context7.com
    email: support@context7.com
servers:
  - url: https://context7.com/api
    description: Production server
tags:
  - name: Search
    description: Search for libraries in the Context7 database
  - name: Context
    description: Retrieve documentation context for queries
  - name: Ask
    description: Answer questions from a website registered with Context7 Ask
  - name: Refresh
    description: Refresh existing libraries to fetch latest documentation
  - name: Policies
    description: Manage teamspace access policies and filters
  - name: Add Library
    description: Submit new libraries for documentation processing
  - name: Metrics
    description: Retrieve usage metrics for libraries
  - name: Usage
    description: See member and teamspace API usage
  - name: Teamspaces
    description: Teamspaces the caller is a member of. The management API
      (`/v2/teamspaces/*`) accepts a Context7 API key created with management
      access (other keys get 403 `management_access_required`), which reaches
      only its own teamspace, or an OAuth token issued for the Context7 Admin
      MCP server (`https://admin.mcp.context7.com/mcp`), which reaches every
      teamspace of the user. A browser session is not accepted.
  - name: Teamspace Admin
    description: Members, invitations, rules, library policies and requests, usage
      and the spending limit of a teamspace.
  - name: Teamspace Libraries
    description: "A teamspace's libraries: its private sources and the libraries it
      has claimed. Add, refresh, configure, version, claim and remove them, and
      read their parse state and usage. A library id `/owner/repo` is two path
      segments."
  - name: Docs7 Sites
    description: 'Docs7 documentation sites of a teamspace: settings, custom
      domains, deployments, previews and the Docs7 agents. Any member can read;
      owners and admins can change; developers can add a site, publish one added
      for the agents only, and rebuild. Sites deployed with the `docs7 deploy`
      CLI have `source: "local"`; operations marked GitHub-only answer 404 for
      them.'
  - name: Docs7 Analytics
    description: "Traffic of one Docs7 site: visitors, AI crawlers, searches,
      assistant questions and page feedback. Docs7 Free reads the last 7 days,
      Docs7 Pro the last 90."
  - name: Ask Sites
    description: "Manage a teamspace's Context7 Ask sites: add, verify, remove, and
      read their analytics and question log"
paths:
  /v2/teamspaces/{teamspaceId}/sites/{siteId}/deployments/{deploymentId}:
    get:
      tags:
        - Docs7 Sites
      summary: Get a deployment
      description: 'One build. Any member. Only for GitHub sites: a CLI site (`source:
        "local"`) answers 404.'
      operationId: getDocsDeployment
      parameters:
        - name: teamspaceId
          in: path
          required: true
          description: Teamspace id.
          schema:
            type: string
            format: uuid
        - name: siteId
          in: path
          required: true
          description: Docs7 site id.
          schema:
            type: string
            format: uuid
        - name: deploymentId
          in: path
          required: true
          description: Deployment id.
          schema:
            type: string
            format: uuid
      security:
        - bearerAuth: []
      responses:
        "200":
          description: The build
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: "#/components/schemas/Docs7Deployment"
        "400":
          description: Invalid teamspace or site id
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Docs7Error"
              example:
                error: invalid_id
                message: Invalid site id.
        "401":
          description: Missing or invalid bearer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Docs7Error"
              example:
                error: unauthorized
                message: Authentication required.
        "403":
          description: Not a member, missing role, or an API key of another teamspace
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Docs7Error"
              example:
                error: forbidden
                message: You do not have permission to do this.
        "404":
          description: No such site in this teamspace
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Docs7Error"
              example:
                error: not_found
                message: Site not found.
        "500":
          description: Internal error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Docs7Error"
              example:
                error: internal_error
                message: Internal server error.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Get your API key at
        [context7.com/dashboard](https://context7.com/dashboard). Treat your API
        key like a password and store it securely.
  schemas:
    Docs7Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Error code (snake_case).
        message:
          type: string
          description: Human-readable message. Most errors have one.
        details:
          type: object
          description: Validation details on `invalid_payload`.
      description: Docs7 error response
    Docs7Deployment:
      type: object
      required:
        - id
        - siteId
        - hostname
        - target
        - trigger
        - state
        - createdAt
      properties:
        id:
          type: string
          format: uuid
        siteId:
          type: string
          format: uuid
        hostname:
          type: string
        workerName:
          type: string
        target:
          type: string
          enum:
            - production
            - preview
        branch:
          type: string
          description: Preview branch; null for production.
          nullable: true
        trigger:
          type: string
          enum:
            - connect
            - manual
            - push
            - pull_request
        state:
          type: string
          enum:
            - queued
            - building
            - succeeded
            - failed
            - canceled
        sourceKind:
          type: string
          enum:
            - git
            - cli
        attributionRequired:
          type: boolean
        requestedCommitSha:
          type: string
          nullable: true
        commitSha:
          type: string
          nullable: true
        commitMessage:
          type: string
          nullable: true
        triggeredBy:
          type: string
          description: User id when a member started the build.
          nullable: true
        createdAt:
          type: string
          format: date-time
        startedAt:
          type: string
          format: date-time
          nullable: true
        completedAt:
          type: string
          format: date-time
          nullable: true
        failure:
          type: object
          required:
            - kind
            - message
          properties:
            kind:
              type: string
              enum:
                - content
                - configuration
                - source
                - capacity
                - platform
            message:
              type: string
          description: Only on a failed build.
        cancellation:
          type: object
          required:
            - reason
          properties:
            reason:
              type: string
              enum:
                - superseded
                - preview_removed
                - site_removed
                - target_changed
            replacementDeploymentId:
              type: string
              format: uuid
          description: Only on a canceled build.
````
