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

# Stop a workspace

> Stop the workspace and keep its state and config for start. A stopped workspace answers as it is, so a stop can be repeated.

> [accordion] Errors
>
> | Status | Meaning |
> | - | - |
> | `401` | The token is missing or wrong |
> | `404` | The workspace, session, job or file does not exist |
> | `422` | Validation Error |
> | `429` | Past a rate limit, or a new session past max\_sessions |
>
> See [error examples and recovery steps](https://docs.mirage.strukto.ai/api/errors.md). The [complete OpenAPI contract](https://github.com/strukto-ai/mirage/blob/main/docs/openapi.yaml) includes every response schema.


## OpenAPI

````yaml /openapi.yaml post /v1/workspaces/{workspace_id}/stop
openapi: 3.2.0
info:
  title: Mirage API
  version: '0.1'
servers:
  - url: https://api.strukto.ai
    description: The hosted API
security:
  - bearerAuth: []
tags:
  - name: Workspace operations
    x-group: Workspaces
  - name: Workspaces
    x-group: Lifecycle
    parent: Workspace operations
  - name: Sessions
  - name: Shell
    parent: Workspace operations
  - name: VFS
    parent: Workspace operations
  - name: Tools
  - name: Documents
    parent: Workspace operations
  - name: Snapshots
  - name: Templates
  - name: Saved VFS
    x-group: VFS
    parent: Saved configurations
  - name: Saved CLIs
    x-group: CLIs
    parent: Saved configurations
  - name: Saved runtimes
    x-group: Runtimes
    parent: Saved configurations
  - name: Saved configurations
  - name: Policies
  - name: Asks
    parent: Workspace operations
  - name: Server
  - name: Auth
paths:
  /v1/workspaces/{workspace_id}/stop:
    post:
      tags:
        - Workspaces
      summary: Stop a workspace
      description: >-
        Stop the workspace and keep its state and config for start. A stopped
        workspace answers as it is, so a stop can be repeated.
      operationId: stop_workspace_v1_workspaces__workspace_id__stop_post
      parameters:
        - $ref: '#/components/parameters/workspaceId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkspaceResponse'
      servers:
        - url: http://127.0.0.1:8765
          description: A local daemon on its default port
components:
  parameters:
    workspaceId:
      name: workspace_id
      in: path
      required: true
      description: The workspace's id.
      schema:
        type: string
      example: demo
  schemas:
    DeleteWorkspaceResponse:
      properties:
        id:
          title: Id
          type: string
        closed_at:
          type: number
          title: Closed At
      type: object
      required:
        - id
        - closed_at
      title: DeleteWorkspaceResponse
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The server's token (MIRAGE_AUTH_TOKEN) or a JWT. A daemon in the default
        local mode with no token accepts requests without one.

````

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