# Get a notification route

`GET /apis/cra.diagrid.io/v1beta1/projects/{ProjectId}/notificationroutes/{NotificationRouteId}`

Get a notification route by name.

## Request

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `ProjectId` | string | Yes | Unique identifier of the project. |
| `NotificationRouteId` | string | Yes | Unique identifier of the notification route. |

## Responses

### 200 — The notification route.

`application/json`

- `apiVersion` (string)
- `kind` (string)
- `metadata` (object)
  - `name` (string)
  - `uid` (string)
  - `resourceVersion` (integer)
  - `createdAt` (string)
  - `updatedAt` (string)
  - `deletedAt` (string)
  - `labels` (object<string, string>)
  - `annotations` (object)
- `spec` (object) — NotificationRouteSpec is the desired state of a NotificationRoute.
  - `type` (string) — Type selects which kind of alert this route matches, by AlertType enum name (for example ALERT_TYPE_WORKFLOW). Empty matches every type, leaving the filter as the only selector.
  - `filter` (object[]) — Filter narrows the alerts selected by Type. The matchers are ANDed; an empty filter matches every alert of the project.
    - `key` (string) — Required. Key is the alert label to match.
    - `op` (string) — Required. Op is the comparison to apply. One of: `=`, `!=`, `=~`, `!~`.
    - `value` (string) — Value is compared against the label; for =~ and !~ it is a regular expression.
  - `destinations` (string[]) — Required. Destinations names the NotificationDestinations matching alerts are delivered to. Min items: 1.
- `status` (object) — NotificationRouteStatus is the public status of a NotificationRoute.
  - `status` (string) — Status is the current processing status of the resource.
  - `updatedAt` (string) — UpdatedAt is the time of the last status update.
  - `messages` (object[]) — Messages contains any status messages, such as error details.
    - `message` (string)
  - `processedSpecVersion` (integer (int64)) — ProcessedSpecVersion is the spec version last processed by the consuming controller.

Example:

```json
{
  "apiVersion": "cra.diagrid.io/v1beta1",
  "kind": "NotificationRoute",
  "metadata": {
    "name": "workflow-failures"
  },
  "spec": {
    "filter": [
      {
        "key": "workflow",
        "op": "=~",
        "value": "order-.*"
      }
    ],
    "destinations": [
      "ops-webhook"
    ]
  }
}
```

`application/vnd.api+json`

JSONAPI.org specification notification route response wrapper for UI.

- `data` (object) — Required.
  - `type` (string) — Type of the resource object.
  - `id` (string) — Unique identifier of the resource object.
  - `attributes` (object)
    - `apiVersion` (string)
    - `kind` (string)
    - `metadata` (object)
      - `name` (string)
      - `uid` (string)
      - `resourceVersion` (integer)
      - `createdAt` (string)
      - `updatedAt` (string)
      - `deletedAt` (string)
      - `labels` (object<string, string>)
      - `annotations` (object)
    - `spec` (object) — NotificationRouteSpec is the desired state of a NotificationRoute.
      - `type` (string) — Type selects which kind of alert this route matches, by AlertType enum name (for example ALERT_TYPE_WORKFLOW). Empty matches every type, leaving the filter as the only selector.
      - `filter` (object[]) — Filter narrows the alerts selected by Type. The matchers are ANDed; an empty filter matches every alert of the project.
        - `key` (string) — Required. Key is the alert label to match.
        - `op` (string) — Required. Op is the comparison to apply. One of: `=`, `!=`, `=~`, `!~`.
        - `value` (string) — Value is compared against the label; for =~ and !~ it is a regular expression.
      - `destinations` (string[]) — Required. Destinations names the NotificationDestinations matching alerts are delivered to. Min items: 1.
    - `status` (object) — NotificationRouteStatus is the public status of a NotificationRoute.
      - `status` (string) — Status is the current processing status of the resource.
      - `updatedAt` (string) — UpdatedAt is the time of the last status update.
      - `messages` (object[]) — Messages contains any status messages, such as error details.
        - `message` (string)
      - `processedSpecVersion` (integer (int64)) — ProcessedSpecVersion is the spec version last processed by the consuming controller.
  - `relationships` (object<string, object>) — Members of the relationships object represent references from the resource object in which it's defined to other resource objects.
    - Any of:
      - **option 1**
      - **option 2**
      - **option 3**
  - `links` (object<string, object>) — Link members related to the primary data.
    - One of:
      - **string (uri-reference)** — A string containing the link's URL.
      - **object**
        - `href` (string (uri-reference)) — Required. A string containing the link's URL.
        - `meta` (object) — Non-standard meta-information that can not be represented as an attribute or relationship.
  - `meta` (object) — Non-standard meta-information that can not be represented as an attribute or relationship.
- `links` (object<string, object>) — Link members related to the primary data.
  - One of:
    - **string (uri-reference)** — A string containing the link's URL.
    - **object**
      - `href` (string (uri-reference)) — Required. A string containing the link's URL.
      - `meta` (object) — Non-standard meta-information that can not be represented as an attribute or relationship.

### 404 — The notification route was not found.

`application/json`

In the case of an error, a standard format error response body will be returned and the HTTP status code will be set to an error status. The response contains an object with a single error object.

- `code` (string) — Required. This is the same as the HTTP status of the response.
- `message` (string) — Required. A short description of the error.
- `status` (object) — Required. A status code that indicates the error type.
- `details` (object) — Additional details about the errors.
  - `@type` (string) — The type of error.
  - `reason` (string) — A reason for the error.
  - `domain` (string) — The domain in which the error occurred.
  - `metadata` (object) — Additional metadata about the error.

`application/vnd.api+json`

JSONAPI.org specification error response wrapper for UI.

- `error` (object) — In the case of an error, a standard format error response body will be returned and the HTTP status code will be set to an error status. The response contains an object with a single error object.
  - `code` (string) — Required. This is the same as the HTTP status of the response.
  - `message` (string) — Required. A short description of the error.
  - `status` (object) — Required. A status code that indicates the error type.
  - `details` (object) — Additional details about the errors.
    - `@type` (string) — The type of error.
    - `reason` (string) — A reason for the error.
    - `domain` (string) — The domain in which the error occurred.
    - `metadata` (object) — Additional metadata about the error.
- `meta` (object<string, object>) — Link members related to the primary data.
  - One of:
    - **string (uri-reference)** — A string containing the link's URL.
    - **object**
      - `href` (string (uri-reference)) — Required. A string containing the link's URL.
      - `meta` (object) — Non-standard meta-information that can not be represented as an attribute or relationship.
- `links` (object) — Non-standard meta-information that can not be represented as an attribute or relationship.

### default — Unexpected error.

`application/json`

In the case of an error, a standard format error response body will be returned and the HTTP status code will be set to an error status. The response contains an object with a single error object.

- `code` (string) — Required. This is the same as the HTTP status of the response.
- `message` (string) — Required. A short description of the error.
- `status` (object) — Required. A status code that indicates the error type.
- `details` (object) — Additional details about the errors.
  - `@type` (string) — The type of error.
  - `reason` (string) — A reason for the error.
  - `domain` (string) — The domain in which the error occurred.
  - `metadata` (object) — Additional metadata about the error.

`application/vnd.api+json`

JSONAPI.org specification error response wrapper for UI.

- `error` (object) — In the case of an error, a standard format error response body will be returned and the HTTP status code will be set to an error status. The response contains an object with a single error object.
  - `code` (string) — Required. This is the same as the HTTP status of the response.
  - `message` (string) — Required. A short description of the error.
  - `status` (object) — Required. A status code that indicates the error type.
  - `details` (object) — Additional details about the errors.
    - `@type` (string) — The type of error.
    - `reason` (string) — A reason for the error.
    - `domain` (string) — The domain in which the error occurred.
    - `metadata` (object) — Additional metadata about the error.
- `meta` (object<string, object>) — Link members related to the primary data.
  - One of:
    - **string (uri-reference)** — A string containing the link's URL.
    - **object**
      - `href` (string (uri-reference)) — Required. A string containing the link's URL.
      - `meta` (object) — Non-standard meta-information that can not be represented as an attribute or relationship.
- `links` (object) — Non-standard meta-information that can not be represented as an attribute or relationship.