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

# Cancel a deployment

> Stops a deployment that is queued or building: it ends as `cancelled`, never goes live, sends no email and leaves the app as it was. A deployment already built, failed or cancelled is refused.



## OpenAPI

````yaml https://dojo.frogbot.ai/api/openapi.json post /api/deployments/{id}/cancel
openapi: 3.1.0
info:
  title: Dojo API
  version: '1'
  description: >-
    Everything Dojo's pages do, for scripts and agents. Sign in with an API key
    as `Authorization: Bearer fb_…`. Paying and accepting the terms happen at a
    link a route answers, for a person to open.
servers:
  - url: https://dojo.frogbot.ai
security:
  - apiKey: []
tags:
  - name: Sign-in
  - name: Workspaces
  - name: Projects
  - name: Apps
  - name: Templates
  - name: Sharing
  - name: Deployments
  - name: Environment variables
  - name: Domains
  - name: Data
  - name: Billing
  - name: API keys
paths:
  /api/deployments/{id}/cancel:
    post:
      tags:
        - Deployments
      summary: Cancel a deployment
      description: >-
        Stops a deployment that is queued or building: it ends as `cancelled`,
        never goes live, sends no email and leaves the app as it was. A
        deployment already built, failed or cancelled is refused.
      operationId: post/api/deployments/:id/cancel
      parameters:
        - name: id
          in: path
          required: true
          description: The deployment's id.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - cancelled
                  finishedAt:
                    type: string
                    format: date-time
                required:
                  - status
                  - finishedAt
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: '`forbidden`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: '`not_found`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: '`conflict`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
components:
  schemas:
    Errors:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              message:
                type: string
              data:
                type: object
                properties:
                  code:
                    type: string
                  url:
                    type: string
                    description: Where a person takes the next step, such as paying.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from `frogbot deploy`'s sign-in, `/api/cli/device/token`, or
        the API keys page.

````

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