---
title: "Get detection rule"
method: GET
path: "/catalog/v1/detection-rules/{urn}"
tags: ["Detection Rules"]
---

# Get detection rule

`GET /catalog/v1/detection-rules/{urn}`

## Request

- Base URL: `https://your-environment.ataccama.one/api`
- URL: `https://your-environment.ataccama.one/api/catalog/v1/detection-rules/{urn}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/docs/catalog/v1/detection-rules/:urn/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a detection rule by URN.

## Path parameters

- `urn` string, uri, required: A URN identifying a detection rule resource in the Catalog API. Format: urn:ata:{tenant}:catalog:detection-rule:{uuid} Example: urn:ata:acme-corp:catalog:detection-rule:123e4567-e89b-12d3-a456-426614174000.

## Query parameters

- `extraProperties` string[]

## Response `200`

The detection rule.

- DetectionRuleResponse
  - `urn` string, uri, required: A URN identifying a detection rule resource in the Catalog API. Format: urn:ata:{tenant}:catalog:detection-rule:{uuid} Example: urn:ata:acme-corp:catalog:detection-rule:123e4567-e89b-12d3-a456-426614174000.
  - `name` string, required
  - `description` string
  - `type` string, required: The type of a detection rule. DATA rules evaluate a single input; METADATA rules evaluate a predefined set of system inputs.
  - `expression` DetectionRuleExpression: Represents an expression used within a detection rule. Expressions reference the rule's inputs and variables by name.
    - `stringExpression` string: Advanced Expression leveraging ONE expressions.
  - `variables` object, nullable: Variables derived from the rule's input(s) and reused within the rule expression, keyed by their id (UUID).
  - `extraProperties` ExtraProperties: A map of properties associated with the entity defined in the metadata model. Only scalar and reference properties are supported, including arrays. In responses, only properties explicitly requested via the `extraProperties` query parameter are included. In `PATCH` requests, only the properties listed in the body are modified; set a property to `null` (for scalars) or `[]` (for reference arrays) to clear its value. To find which extra properties are available for an entity, retrieve its entity definition through the Metadata model entities endpoints: `catalogItem` for catalog items, `attribute` for catalog attributes, `source` for sources, `folder` for folders, and the term's own `type` (for example, `businessTerm`) for terms.

## Other responses

- `403`: Forbidden. You do not have permission to access the requested resource.
- `404`: Not found. The requested resource does not exist.

---

[API](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api.md) - [All operations](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/revisions/46f16e0487f8?raw)