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

# Enable or disable output destination

> Disable an output destination to stop every delivery to it while keeping its configuration and the agents and notifications routed to it, or enable it again.



## OpenAPI

````yaml https://app.cotool.ai/api/docs/openapi.json put /api/output-destinations/{destinationId}/enabled
openapi: 3.1.0
info:
  title: Cotool API
  version: 1.0.0
  description: >-
    The Cotool REST API. Authenticate with an API key from `/settings/api-keys`
    sent as `Authorization: Bearer <key>`.


    Authentication, error formats, pagination, and common integration recipes
    are documented in the [API
    overview](https://docs.cotool.ai/api-reference/introduction). Endpoints
    marked **Deprecated** keep working; each one's description names its
    replacement.
servers:
  - url: https://app.cotool.ai
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Agents
    description: Create, update, run, and version agents.
  - name: Agent Runs
    description: Inspect agent runs, submit feedback, and read evaluation metrics.
  - name: Agent Triggers
    description: Webhook, schedule, and integration triggers that start agent runs.
  - name: Agents as Code
    description: Validate agents and skills defined as YAML in a Git repository.
  - name: Skills
    description: Reusable instructions and tool grants attached to agents.
  - name: Chat
    description: Chat sessions and their transcripts.
  - name: Alerts
    description: Alert triage, routing, and escalation notifications.
  - name: Output Destinations
    description: Webhook, Slack, Jira, and Linear destinations for agent output.
  - name: Detections
    description: Detection agents, detection hits, and the Cotool detection library.
  - name: Hunt
    description: Autonomous hunt threats, gaps, and settings.
  - name: Intel
    description: Threat-intelligence feed items, indicators, and sources.
  - name: Threat Model
    description: The organization threat model and its version history.
  - name: MITRE Coverage
    description: MITRE ATT&CK coverage across detections.
  - name: Tools
    description: Connected tool integrations and captured tool output.
  - name: CLIs
    description: Connected CLI integrations.
  - name: Artifacts
    description: Files and reports produced by agent runs.
  - name: Audit Logs
    description: Organization audit log export and event catalog.
  - name: Users
    description: Users, memberships, and the current session.
  - name: Roles
    description: Role-based permissions.
  - name: Organizations
    description: Organization-level metrics.
paths:
  /api/output-destinations/{destinationId}/enabled:
    put:
      tags:
        - Output Destinations
      summary: Enable or disable output destination
      description: >-
        Disable an output destination to stop every delivery to it while keeping
        its configuration and the agents and notifications routed to it, or
        enable it again.
      parameters:
        - in: path
          name: destinationId
          schema:
            type: string
            format: uuid
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: >-
                    False to stop every delivery to the destination while
                    keeping its configuration and routes; true to resume
              required:
                - enabled
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Unique identifier for the destination
                      organizationId:
                        type: string
                        format: uuid
                        description: Organization that owns this destination
                      name:
                        type: string
                        minLength: 1
                        maxLength: 255
                        description: Human-readable name for this destination
                      createdAt:
                        type: string
                        description: When the destination was created
                      updatedAt:
                        type: string
                        description: When the destination was last updated
                      disabledAt:
                        type:
                          - string
                          - 'null'
                        description: >-
                          When the destination was disabled; nothing is
                          delivered to a disabled destination. Null or absent
                          when enabled.
                      type:
                        type: string
                        const: webhook
                      config:
                        type: object
                        properties:
                          url:
                            type: string
                            format: uri
                            description: The webhook URL to POST to
                          authType:
                            type: string
                            enum:
                              - bearer
                              - header
                            description: >-
                              Type of authentication: "bearer" for
                              Authorization: Bearer <token>, "header" for custom
                              header
                          headerName:
                            type: string
                            description: >-
                              Custom header name when authType is "header"
                              (e.g., "X-API-Key")
                        required:
                          - url
                          - authType
                      token:
                        type: string
                        description: >-
                          The authentication token (only returned to authorized
                          users)
                      hasToken:
                        type: boolean
                        description: Whether a token is configured
                      usageCount:
                        type: number
                        description: Number of detections using this destination
                    required:
                      - id
                      - organizationId
                      - name
                      - createdAt
                      - updatedAt
                      - type
                      - config
                      - usageCount
                  - type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Unique identifier for the destination
                      organizationId:
                        type: string
                        format: uuid
                        description: Organization that owns this destination
                      name:
                        type: string
                        minLength: 1
                        maxLength: 255
                        description: Human-readable name for this destination
                      createdAt:
                        type: string
                        description: When the destination was created
                      updatedAt:
                        type: string
                        description: When the destination was last updated
                      disabledAt:
                        type:
                          - string
                          - 'null'
                        description: >-
                          When the destination was disabled; nothing is
                          delivered to a disabled destination. Null or absent
                          when enabled.
                      type:
                        type: string
                        const: teams
                      config:
                        type: object
                        properties:
                          url:
                            type: string
                            format: uri
                            description: >-
                              The Microsoft Teams workflow webhook URL to POST
                              to
                        required:
                          - url
                      usageCount:
                        type: number
                        description: Number of detections using this destination
                    required:
                      - id
                      - organizationId
                      - name
                      - createdAt
                      - updatedAt
                      - type
                      - config
                      - usageCount
                  - type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Unique identifier for the destination
                      organizationId:
                        type: string
                        format: uuid
                        description: Organization that owns this destination
                      name:
                        type: string
                        minLength: 1
                        maxLength: 255
                        description: Human-readable name for this destination
                      createdAt:
                        type: string
                        description: When the destination was created
                      updatedAt:
                        type: string
                        description: When the destination was last updated
                      disabledAt:
                        type:
                          - string
                          - 'null'
                        description: >-
                          When the destination was disabled; nothing is
                          delivered to a disabled destination. Null or absent
                          when enabled.
                      type:
                        type: string
                        const: slack
                      config:
                        type: object
                        properties:
                          channelIds:
                            type: array
                            items:
                              type: string
                            minItems: 1
                            description: Slack channel IDs to post messages to
                          configurationRevision:
                            type: integer
                            minimum: 0
                            description: >-
                              Revision of user-managed Slack delivery
                              configuration
                          blockedChannels:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                reason:
                                  type: string
                                  const: archived
                                  description: >-
                                    Why delivery to this Slack channel is
                                    blocked
                                blockedAt:
                                  type: string
                                  description: >-
                                    When Slack reported that the channel was
                                    archived
                              required:
                                - reason
                                - blockedAt
                            description: >-
                              Channels that delivery will skip until a user
                              updates the destination
                        required:
                          - channelIds
                      usageCount:
                        type: number
                        description: Number of detections using this destination
                    required:
                      - id
                      - organizationId
                      - name
                      - createdAt
                      - updatedAt
                      - type
                      - config
                      - usageCount
                  - type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Unique identifier for the destination
                      organizationId:
                        type: string
                        format: uuid
                        description: Organization that owns this destination
                      name:
                        type: string
                        minLength: 1
                        maxLength: 255
                        description: Human-readable name for this destination
                      createdAt:
                        type: string
                        description: When the destination was created
                      updatedAt:
                        type: string
                        description: When the destination was last updated
                      disabledAt:
                        type:
                          - string
                          - 'null'
                        description: >-
                          When the destination was disabled; nothing is
                          delivered to a disabled destination. Null or absent
                          when enabled.
                      type:
                        type: string
                        const: pagerduty
                      config:
                        type: object
                        properties:
                          severity:
                            type: string
                            enum:
                              - critical
                              - error
                              - warning
                              - info
                            description: Default severity level for alerts
                          source:
                            type: string
                            description: >-
                              Optional source identifier (defaults to detection
                              name)
                        required:
                          - severity
                      usageCount:
                        type: number
                        description: Number of detections using this destination
                    required:
                      - id
                      - organizationId
                      - name
                      - createdAt
                      - updatedAt
                      - type
                      - config
                      - usageCount
                  - type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Unique identifier for the destination
                      organizationId:
                        type: string
                        format: uuid
                        description: Organization that owns this destination
                      name:
                        type: string
                        minLength: 1
                        maxLength: 255
                        description: Human-readable name for this destination
                      createdAt:
                        type: string
                        description: When the destination was created
                      updatedAt:
                        type: string
                        description: When the destination was last updated
                      disabledAt:
                        type:
                          - string
                          - 'null'
                        description: >-
                          When the destination was disabled; nothing is
                          delivered to a disabled destination. Null or absent
                          when enabled.
                      type:
                        type: string
                        const: linear
                      config:
                        type: object
                        properties:
                          teamId:
                            type: string
                            minLength: 1
                            description: Linear team ID where issues should be created
                          teamName:
                            type: string
                            description: Cached team name for display purposes
                          labelIds:
                            type: array
                            items:
                              type: string
                            description: Linear label IDs to apply to created issues
                          labelNames:
                            type: array
                            items:
                              type: string
                            description: Cached Linear label names for display purposes
                          workflowStateId:
                            type: string
                            minLength: 1
                            description: Linear workflow state ID for created issues
                          workflowStateName:
                            type: string
                            description: >-
                              Cached Linear workflow state name for display
                              purposes
                        required:
                          - teamId
                      usageCount:
                        type: number
                        description: Number of detections using this destination
                    required:
                      - id
                      - organizationId
                      - name
                      - createdAt
                      - updatedAt
                      - type
                      - config
                      - usageCount
                  - type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Unique identifier for the destination
                      organizationId:
                        type: string
                        format: uuid
                        description: Organization that owns this destination
                      name:
                        type: string
                        minLength: 1
                        maxLength: 255
                        description: Human-readable name for this destination
                      createdAt:
                        type: string
                        description: When the destination was created
                      updatedAt:
                        type: string
                        description: When the destination was last updated
                      disabledAt:
                        type:
                          - string
                          - 'null'
                        description: >-
                          When the destination was disabled; nothing is
                          delivered to a disabled destination. Null or absent
                          when enabled.
                      type:
                        type: string
                        const: tines
                      config:
                        type: object
                        properties:
                          teamId:
                            type: string
                            pattern: ^\d+$
                            description: Tines team ID where cases should be created
                          teamName:
                            type: string
                            description: Cached team name for display purposes
                        required:
                          - teamId
                      usageCount:
                        type: number
                        description: Number of detections using this destination
                    required:
                      - id
                      - organizationId
                      - name
                      - createdAt
                      - updatedAt
                      - type
                      - config
                      - usageCount
        '400':
          description: Bad request — input validation failed or the request was malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized — missing or invalid API key / session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — the authenticated user lacks the required permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: shell
          label: cURL
          source: >-
            curl -X PUT
            "https://app.cotool.ai/api/output-destinations/:destinationId/enabled"
            \
              -H "Authorization: Bearer YOUR_API_KEY" \
              -H "Content-Type: application/json" \
              -d '{"enabled":true}'
components:
  schemas:
    ValidationError:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
        issues:
          type: array
          description: >-
            Detailed validation issues, present when request or response schema
            validation fails
          items:
            type: object
            additionalProperties: true
      required:
        - error
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
      required:
        - error
    PermissionError:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
        missingPerms:
          type: array
          description: Permissions the authenticated user is missing for this operation
          items:
            type: string
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key authentication for programmatic access. Include your API key in
        the Authorization header as: `Bearer your_api_key_here`

````

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