> ## Documentation Index > Fetch the complete documentation index at: https://www.towbar.dev/llms.txt > Use this file to discover all available pages before exploring further. # Create Scout alert rule > Create Scout alert rule through the Towbar REST API. Required permissions: alert.configure. Personal keys are capped by their owner’s current team role. See [request conventions](/docs/api/overview) and [automation workflows](/docs/api/workflows). MCP clients use the task-oriented [tool catalogue](/docs/api/mcp-tools). ## OpenAPI ````yaml api-reference/openapi.json POST /servers/{serverId}/scout-alerts/rules openapi: 3.1.0 info: title: Towbar API version: 2.0.0 description: >- Manage your Towbar control plane with a bearer API key. Keys inherit current workspace permissions. servers: - url: https://api.example.com/v1/api security: [] paths: /servers/{serverId}/scout-alerts/rules: post: tags: - Servers / Scout Alerts summary: Create Scout alert rule description: >- Required permissions: alert.configure. Personal keys are capped by the current member role; team keys use explicit grants. operationId: post_servers_by_id_scout_alerts_rules parameters: - name: serverId in: path required: true schema: $schema: https://json-schema.org/draft/2020-12/schema type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ requestBody: required: true content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: name: type: string minLength: 1 maxLength: 100 enabled: default: true type: boolean severity: default: warning type: string enum: - warning - critical deployableId: default: null anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' condition: type: object properties: metric: type: string enum: - cpuPercent - cpuCores - cpuLimitCores - memoryUsedBytes - memoryTotalBytes - memoryLimitBytes - memoryPercent - swapUsedBytes - swapTotalBytes - diskTotalBytes - diskUsedBytes - diskPercent - dockerDiskTotalBytes - dockerDiskUsedBytes - dockerDiskPercent - diskReadBytesPerSecond - diskWriteBytesPerSecond - networkRxBytesPerSecond - networkTxBytesPerSecond - uptimeSeconds - load1 - load5 - load15 - restarts - missingReports - httpAvailability http: type: object properties: url: type: string maxLength: 2048 format: uri method: default: GET type: string enum: - GET - HEAD intervalSeconds: default: 60 type: integer minimum: 30 maximum: 300 multipleOf: 30 timeoutSeconds: default: 5 type: integer minimum: 1 maximum: 10 expectedStatusMin: default: 200 type: integer minimum: 100 maximum: 599 expectedStatusMax: default: 299 type: integer minimum: 100 maximum: 599 maxRedirects: default: 0 type: integer minimum: 0 maximum: 3 required: - url additionalProperties: false operator: default: above type: string enum: - above - below threshold: type: number minimum: 0 maximum: 1000000000000000000 windowSeconds: default: 300 type: integer minimum: 60 maximum: 3600 aggregation: default: average type: string enum: - average - peak required: - metric - threshold additionalProperties: false required: - name - condition additionalProperties: false responses: '201': description: >- The saved rule; notifications start only after the condition is satisfied. content: application/json: schema: allOf: - $ref: '#/components/schemas/Response_87' - type: object properties: localization: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: dateFormat: type: string enum: - day-short-month-year - short-month-day-year - year-month-day - day-month-year - month-day-year timeFormat: type: string enum: - 24-hour - 12-hour - 24-hour-seconds - 12-hour-seconds timeZone: type: string timestamps: type: object propertyNames: type: string additionalProperties: type: object properties: date: type: string time: type: - string - 'null' dateTime: type: - string - 'null' timeZone: type: string zoneLabel: type: string epochMilliseconds: type: number inputDateTime: type: - string - 'null' required: - date - time - dateTime - timeZone - zoneLabel - epochMilliseconds - inputDateTime additionalProperties: false required: - dateFormat - timeFormat - timeZone - timestamps additionalProperties: false required: - localization '400': $ref: '#/components/responses/ApiError' '401': $ref: '#/components/responses/ApiError' '403': $ref: '#/components/responses/ApiError' '404': $ref: '#/components/responses/ApiError' '409': $ref: '#/components/responses/ApiError' '413': $ref: '#/components/responses/ApiError' '422': $ref: '#/components/responses/ApiError' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/ApiError' security: - bearerAuth: [] components: schemas: Response_87: type: object properties: rule: $ref: '#/components/schemas/Response_88' required: - rule Response_88: type: object responses: ApiError: description: Request failed. The error object contains code, message, and requestId. content: application/json: schema: type: object properties: error: type: object required: - code - message - requestId properties: code: type: string message: type: string requestId: type: string RateLimited: description: Request failed. The error object contains code, message, and requestId. content: application/json: schema: type: object properties: error: type: object required: - code - message - requestId properties: code: type: string message: type: string requestId: type: string headers: Retry-After: description: Seconds before retrying schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Towbar API key ````