# Trigger deployment

> Queue a deployment update for your documentation project. Returns a status ID that can be used to track the update progress. The update is triggered from your configured deployment branch.

Authenticate with an admin API key.

## OpenAPI

```yaml openapi.json POST /project/update/{projectId}
openapi: 3.0.1
info:
  title: Mintlify External API
  description: An API for Mintlify documentation management and resource access.
  version: 1.0.0
servers:
  - url: https://api.mintlify.com/v1
security:
  - bearerAuth: []
paths:
  /project/update/{projectId}:
    post:
      summary: Trigger update
      description: >-
        Queue a deployment update for your documentation project. Returns a
        status ID that can be used to track the update progress. The update is
        triggered from your configured deployment branch.


        Authenticate with an admin API key.
      parameters:
        - name: projectId
          in: path
          description: >-
            Your project ID. Can be copied from the [API
            keys](https://app.mintlify.com/settings/organization/api-keys) page
            in your dashboard.
          required: true
          schema:
            type: string
      responses:
        '202':
          description: A successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusId:
                    type: string
                    description: The status ID of the triggered updated.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The Authorization header expects a Bearer token. Use an admin API key.
        This is a server-side secret key. Generate one on the [API keys
        page](https://app.mintlify.com/settings/organization/api-keys) in your
        dashboard.

```

## Related topics

- [GitHub](/docs/deploy/github.md)
- [Mintlify REST API introduction](/docs/api/introduction.md)
- [Roles](/docs/dashboard/roles.md)

## Related pages

- [Get deployment status](./api-update-status.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.