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

# Remove a workspace

> Removes a workspace from CliqHub's catalog, by `id` or `path`. It does not touch the
daemon; daemons call this when a workspace is unregistered there. You must be a realm
admin in a realm of the workspace's daemon. Removing an unknown workspace answers
`removed: false`.

Requires a realm admin on the realm that owns the workspace given by `id`.



## OpenAPI

````yaml /openapi/hub-by-tag/hub-workspaces.yaml post /v1/workspaces/remove
openapi: 3.0.3
info:
  title: 'CliqHub API: Workspaces'
  version: 1.0.0
  description: >-
    The workspaces (project folders) daemons have registered, as CliqHub last
    saw them, with the

    teams assigned to each. Workspaces are created and changed on the daemon
    (`cliq init`,

    `cliq assemble`); CliqHub records them when a run starts and keeps a
    catalog. You see the

    workspaces of daemons in your realms.
servers:
  - url: https://{host}
    variables:
      host:
        default: cliqhub.io
        description: CliqHub host
security: []
tags:
  - name: Workspaces
    description: >-
      The workspaces (project folders) daemons have registered, as CliqHub last
      saw them, with the

      teams assigned to each. Workspaces are created and changed on the daemon
      (`cliq init`,

      `cliq assemble`); CliqHub records them when a run starts and keeps a
      catalog. You see the

      workspaces of daemons in your realms.
paths:
  /v1/workspaces/remove:
    post:
      tags:
        - Workspaces
      summary: Remove a workspace
      description: >-
        Removes a workspace from CliqHub's catalog, by `id` or `path`. It does
        not touch the

        daemon; daemons call this when a workspace is unregistered there. You
        must be a realm

        admin in a realm of the workspace's daemon. Removing an unknown
        workspace answers

        `removed: false`.


        Requires a realm admin on the realm that owns the workspace given by
        `id`.
      operationId: POST_v1_workspaces_remove
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                path:
                  type: string
                  description: The workspace folder, when the id is not known.
                id:
                  type: string
                  description: The workspace id.
            examples:
              default:
                value:
                  id: 9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - removed
                properties:
                  ok:
                    type: boolean
                    enum:
                      - true
                    description: Always `true` on success.
                  removed:
                    type: boolean
              example:
                ok: true
                removed: true
        '400':
          description: '`bad_request`: Neither `path` nor `id` was sent.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                bad_request:
                  summary: bad_request
                  value:
                    ok: false
                    error: path or id is required
                    code: bad_request
        '401':
          description: >-
            `unauthorized`: No `Authorization` header, or the token is
            malformed, expired or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                unauthorized:
                  summary: unauthorized
                  value:
                    ok: false
                    error:
                      code: unauthorized
                      message: Authentication required
        '403':
          description: >-
            `forbidden`: You can see the record but your role in its realm is
            too low or lacks the required permission.


            `forbidden`: You are not a realm admin in a realm of the workspace's
            daemon, or a daemon token was used.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                forbidden:
                  summary: forbidden
                  value:
                    ok: false
                    error:
                      code: forbidden
                      message: You do not have access to do this
                forbidden (endpoint):
                  summary: forbidden (endpoint)
                  value:
                    ok: false
                    error: Realm admin required to remove a workspace
                    code: forbidden
        '404':
          description: >-
            `not_found`: The workspace does not exist or is in a realm you
            cannot see (404 rather than 403, so its existence is not revealed).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                not_found:
                  summary: not_found
                  value:
                    ok: false
                    error:
                      code: not_found
                      message: Not found
        '422':
          description: >-
            `invalid_params`: The body fails the request schema: a field is
            missing or has the wrong type. `details.issues` lists each problem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                invalid_params:
                  summary: invalid_params
                  value:
                    ok: false
                    error: Required
                    code: invalid_params
                    details:
                      issues:
                        - field: path
                          message: Required
        '500':
          description: >-
            `internal_error`: An unexpected server fault. Retry later; if it
            persists, report it with the time of the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                internal_error:
                  summary: internal_error
                  value:
                    ok: false
                    error: Internal server error
                    code: internal_error
      security:
        - BearerAuth: []
components:
  schemas:
    HubErr:
      type: object
      required:
        - ok
        - error
      description: >-
        Every failure. Route-policy denials (401/403/404, and 400 when neither
        realm_id nor org_id was sent) answer `error` as `{ code, message }`;
        errors raised by the endpoint answer `error` as the message with the
        code beside it in `code`. Every error has a code. See
        [Errors](/hub-api/errors).
      properties:
        ok:
          type: boolean
          description: Always false on error
        error:
          description: The message, or `{ code, message }` for an access denial.
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
        code:
          type: string
          description: Stable error code of an endpoint error.
        details:
          type: object
          additionalProperties: true
          description: Structured detail, when there is some.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cliq_tok_* | cliq_dt_*
      description: >-
        User PAT (`cliq_tok_…`, including session-scoped) or realm token
        (`cliq_dt_…`).

````

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