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

# Disable Channel

> Disable a channel.



## OpenAPI

````yaml /versions/2.0.6dev/en/deploy/openapi.json post /channels/{channel_id}/disable
openapi: 3.1.0
info:
  title: AgentScope
  version: 2.0.6dev
servers: []
security: []
paths:
  /channels/{channel_id}/disable:
    post:
      tags:
        - channels
      summary: Disable Channel
      description: Disable a channel.
      operationId: disable_channel_channels__channel_id__disable_post
      parameters:
        - name: channel_id
          in: path
          required: true
          schema:
            type: string
            title: Channel Id
        - name: x-user-id
          in: header
          required: true
          schema:
            type: string
            description: >-
              Caller's user ID. Temporary header-based identity; will be
              replaced by JWT auth.
            title: X-User-Id
          description: >-
            Caller's user ID. Temporary header-based identity; will be replaced
            by JWT auth.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelActionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ChannelActionResponse:
      properties:
        status:
          type: string
          title: Status
          description: New lifecycle status, e.g. 'enabled'.
      type: object
      required:
        - status
      title: ChannelActionResponse
      description: Result of an enable/disable action.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````