> ## Documentation Index > Fetch the complete documentation index at: https://docs.timbal.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Alarm > One alarm's configuration, current state and linked channels. Same shape as an entry in `GET /orgs/{org_id}/alarms`, for refreshing a detail view without refetching the whole list. Needs `alarms.read` for an org-level alarm, or `projects.alarms.read` on the owning project for a project alarm. ## OpenAPI ````yaml GET /orgs/{org_id}/alarms/{alarm_id} openapi: 3.1.0 info: title: Timbal Platform API description: Public API documentation for the Timbal platform license: name: '' version: 2.0.0 servers: - url: https://api.timbal.ai description: Production - url: https://api.dev.timbal.ai description: Development security: [] tags: - name: ace description: Action Control Engine (ACE) operations - name: alarms description: Metric series and threshold alarms - name: analytics description: Org and project analytics - name: billing description: Subscriptions, usage, and payment-related operations - name: channels description: Delivery channels alarms notify through - name: content description: Re-sign stored content URLs - name: files description: File operations - name: iam description: IAM — actions, roles, users, and authorization introspection - name: k2 description: Knowledge Bases v2 operations - name: orgs description: Organization operations - name: projects description: Project operations - name: runs description: Execution operations - name: templates description: Public project template catalog - name: users description: Authenticated user profile paths: /orgs/{org_id}/alarms/{alarm_id}: get: tags: - alarms summary: Get a metric alarm description: >- One alarm's configuration, current state and linked channels. Same shape as an entry in `GET /orgs/{org_id}/alarms`, for refreshing a detail view without refetching the whole list. Needs `alarms.read` for an org-level alarm, or `projects.alarms.read` on the owning project for a project alarm. operationId: get_org_alarm parameters: - name: org_id in: path required: true schema: type: string - name: alarm_id in: path required: true schema: type: string responses: '200': description: The alarm content: application/json: schema: $ref: '#/components/schemas/AlarmOut' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' '404': description: Alarm not found for this org content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - bearer_auth: [] components: schemas: AlarmOut: type: object required: - id - name - metric_name - min_sample_count - dims - stat - period_seconds - comparison - threshold - datapoints_to_alarm - evaluation_periods - missing_data - state - enabled - channels properties: channels: type: array items: $ref: '#/components/schemas/NotificationChannelOut' clear_threshold: type: - number - 'null' format: double description: Set when this alarm uses hysteresis; see [`CreateAlarmReq`]. comparison: $ref: '#/components/schemas/AlarmComparison' datapoints_to_alarm: type: integer format: int32 denominator_metric_name: type: - string - 'null' description: Set when this is a ratio alarm; see [`CreateAlarmReq`]. dims: $ref: '#/components/schemas/AlarmDims' enabled: type: boolean evaluation_periods: type: integer format: int32 id: type: integer format: int64 metric_name: type: string min_sample_count: type: integer format: int64 missing_data: $ref: '#/components/schemas/MissingDataPolicy' name: type: string period_seconds: type: integer format: int32 project_id: type: - integer - 'null' format: int64 description: Project this alarm belongs to; omitted for org-level alarms. stat: $ref: '#/components/schemas/AlarmStat' state: $ref: '#/components/schemas/AlarmState' state_changed_at: type: - string - 'null' format: date-time threshold: type: number format: double ErrorMessage: type: object required: - code - message properties: code: type: string description: Machine-readable error code (e.g. `ALREADY_EXISTS`, `BAD_REQUEST`). message: type: string description: Human-readable description. NotificationChannelOut: type: object required: - id - type - config properties: config: type: object id: type: integer format: int64 name: type: - string - 'null' type: $ref: '#/components/schemas/NotificationChannelType' AlarmComparison: type: string enum: - gt - gte - lt - lte AlarmDims: type: object description: |- Metric dimension filters. Omitted = aggregate across that dimension. Not `Copy` since `label` is owned. properties: deployment_id: type: - string - 'null' label: type: - string - 'null' description: >- `Metrics.label` — the span name behind a trace-derived metric. Scopes the alarm to one tool/step instead of the sum over every span the filter matched. project_env_id: type: - string - 'null' project_id: type: - string - 'null' workforce_id: type: - string - 'null' description: Agent / workflow app (`OrgsApps.id`). MissingDataPolicy: type: string enum: - not_breaching - breaching - insufficient - ignore AlarmStat: type: string description: >- Aggregation applied to each evaluation period. Percentiles run from p0.1 to p99.9 in tenths; equivalent spellings such as p95.0 are accepted and returned canonically as p95, while a finer value such as p95.05 is rejected rather than rounded. They are exact rather than interpolated from bins, so they are only available on app.run.duration_ms and cannot be used with denominator_metric_name. examples: - p99 pattern: ^(avg|sum|count|min|max|p\d+(\.\d+)?)$ AlarmState: type: string enum: - ok - alarm - insufficient_data NotificationChannelType: type: string enum: - email - slack securitySchemes: bearer_auth: type: http scheme: bearer description: >- Timbal API key. Obtain your API key from the Timbal platform settings. See [Authentication](/api-reference/authentication) for more information. ````