> ## 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. # Update detection output configuration > Update output settings for a detection (enable/disable, set destinations, set send mode). ## OpenAPI ````yaml https://app.cotool.ai/api/docs/openapi.json put /api/detections/{id}/outputs openapi: 3.1.0 info: title: Cotool API version: 1.0.0 description: >- # Cotool API Documentation The Cotool API allows you to interact with the Cotool platform programmatically, enabling you to build powerful integrations and automate your workflows. ## Getting an API Key Follow these steps to generate your API key: 1. **Log in** to the Cotool web interface 2. **Navigate** to `/settings/api-keys` 3. **Click** "Generate Key" 4. **Copy and store** your API key securely ⚠️ *It won't be shown again* ## API Key Authentication For programmatic access and integrations, use your API key with the Authorization header: ```http Authorization: Bearer your_api_key_here ``` ```bash curl -X GET "https://app.cotool.ai/api/endpoint" \ -H "Authorization: Bearer your_api_key_here" \ -H "Content-Type: application/json" ``` servers: - url: https://app.cotool.ai description: Production server security: - ApiKeyAuth: [] paths: /api/detections/{id}/outputs: put: tags: - Detections summary: Update detection output configuration description: >- Update output settings for a detection (enable/disable, set destinations, set send mode). parameters: - in: path name: id description: Detection UUID schema: type: string format: uuid description: Detection UUID required: true requestBody: content: application/json: schema: type: object properties: enabled: type: boolean description: Whether output delivery is enabled destinationIds: type: array items: type: string format: uuid description: The output destinations to use sendMode: type: string enum: - triggered_entities_only - all_entities description: What entities to send minSeverity: type: string enum: - low - medium - high - critical description: >- Minimum entity severity eligible for output delivery; defaults to high when omitted inheritOrgDefault: type: boolean description: >- When true, remove the detection override and inherit organization defaults required: - enabled - destinationIds - sendMode responses: '200': description: Successful response content: application/json: schema: type: object properties: id: type: string format: uuid description: Unique identifier for the settings organizationId: type: string format: uuid description: Organization that owns this settings agentId: type: string format: uuid description: Agent these settings apply to enabled: type: boolean description: Whether output delivery is enabled destinationIds: type: array items: type: string format: uuid description: The output destinations to use sendMode: type: string enum: - triggered_entities_only - all_entities description: What entities to send minSeverity: type: string enum: - low - medium - high - critical description: >- Minimum entity severity eligible for detection output delivery acNotificationsEnabled: type: boolean description: >- Whether acceptance criteria failure notifications are enabled acNotificationDestinationIds: type: array items: type: string format: uuid description: Destinations for acceptance criteria failure notifications acNotificationsInheritOrgDefault: type: boolean description: >- Whether response-agent failure/critical notifications inherit organization defaults createdAt: type: string description: When the settings were created updatedAt: type: string description: When the settings were last updated settings: type: - object - 'null' properties: id: type: string format: uuid description: Unique identifier for the settings organizationId: type: string format: uuid description: Organization that owns this settings agentId: type: string format: uuid description: Agent these settings apply to enabled: type: boolean description: Whether output delivery is enabled destinationIds: type: array items: type: string format: uuid description: The output destinations to use sendMode: type: string enum: - triggered_entities_only - all_entities description: What entities to send minSeverity: type: string enum: - low - medium - high - critical description: >- Minimum entity severity eligible for detection output delivery acNotificationsEnabled: type: boolean description: >- Whether acceptance criteria failure notifications are enabled acNotificationDestinationIds: type: array items: type: string format: uuid description: >- Destinations for acceptance criteria failure notifications acNotificationsInheritOrgDefault: type: boolean description: >- Whether response-agent failure/critical notifications inherit organization defaults createdAt: type: string description: When the settings were created updatedAt: type: string description: When the settings were last updated required: - id - organizationId - agentId - enabled - destinationIds - sendMode - minSeverity - createdAt - updatedAt description: Override settings for this detection, if configured effectiveSettings: type: object properties: enabled: type: boolean description: >- Whether detection output delivery is enabled after inheritance is resolved destinationIds: type: array items: type: string format: uuid description: Output destinations after inheritance is resolved sendMode: type: string enum: - triggered_entities_only - all_entities description: What entities to send after inheritance is resolved minSeverity: type: string enum: - low - medium - high - critical description: Minimum entity severity after inheritance is resolved source: type: string enum: - agent_override - organization_default description: >- Whether these settings came from the detection override or organization default required: - enabled - destinationIds - sendMode - minSeverity - source description: >- Effective output settings after applying organization defaults organizationDefaultSettings: type: object properties: id: type: string format: uuid description: >- Unique identifier for the organization default settings organizationId: type: string format: uuid description: Organization that owns these default settings enabled: type: boolean description: Whether default detection output delivery is enabled destinationIds: type: array items: type: string format: uuid description: Default output destinations for detection agents sendMode: type: string enum: - triggered_entities_only - all_entities description: What entities to send by default minSeverity: type: string enum: - low - medium - high - critical description: >- Minimum entity severity eligible for default detection output delivery createdAt: type: string description: When the settings were created updatedAt: type: string description: When the settings were last updated required: - id - organizationId - enabled - destinationIds - sendMode - minSeverity - createdAt - updatedAt description: Organization-wide default output settings for detections destinations: type: array items: oneOf: - 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 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 , "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 required: - id - organizationId - name - createdAt - updatedAt - type - config - 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 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 required: - id - organizationId - name - createdAt - updatedAt - type - config - 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 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 required: - channelIds required: - id - organizationId - name - createdAt - updatedAt - type - config - 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 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 required: - id - organizationId - name - createdAt - updatedAt - type - config - 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 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 required: - teamId required: - id - organizationId - name - createdAt - updatedAt - type - config - 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 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 required: - id - organizationId - name - createdAt - updatedAt - type - config description: Available output destinations for the organization required: - id - organizationId - agentId - enabled - destinationIds - sendMode - minSeverity - createdAt - updatedAt '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/detections/:id/outputs" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"enabled":true,"destinationIds":["string"],"sendMode":"triggered_entities_only","minSeverity":"low","inheritOrgDefault":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` ````