DQ Alert API

The DQ Alert API allows you to manage dataset alerts in Collibra Data Quality & Observability

Return a list of all alerts and their details

get

Returns a list of all alerts and their details.

Responses

200

List of alerts

application/json

datasetstringOptional

alertNmstringOptional

alertCondstringOptional

alertTriggerTypeinteger · int32Write-onlyOptionalDeprecated

Deprecated: Use alertTypes field instead. Alert trigger type mapping: 0 - Condition 1 - Job Failure 2 - Job Complete

alertFormatstringOptional

alertFormatValuestringOptional

alertMsgstringOptional

batchNamestringOptional

addRuleDetailsbooleanOptional

get/v3/alerts

GET /v3/alerts HTTP/1.1
Host: <host-name>
Accept: */*

200

List of alerts

[
  {
    "dataset": "text",
    "alertNm": "text",
    "alertCond": "text",
    "alertFormat": "text",
    "alertFormatValue": "text",
    "alertMsg": "text",
    "batchName": "text",
    "addRuleDetails": true,
    "alertTypes": [
      "CONDITION"
    ]
  }
]

Create or update an alert

post

Creates or updates an alert for a given dataset. Pre-authorization requirements:

hasDatasetAccess(#alertDto.dataset)

Body

datasetstringOptional

alertNmstringOptional

alertCondstringOptional

alertTriggerTypeinteger · int32Write-onlyOptionalDeprecated

Deprecated: Use alertTypes field instead. Alert trigger type mapping: 0 - Condition 1 - Job Failure 2 - Job Complete

alertFormatstringOptional

alertFormatValuestringOptional

alertMsgstringOptional

batchNamestringOptional

addRuleDetailsbooleanOptional

Responses

200

Upserted alert

application/json

datasetstringOptional

alertNmstringOptional

alertCondstringOptional

alertTriggerTypeinteger · int32Write-onlyOptionalDeprecated

Deprecated: Use alertTypes field instead. Alert trigger type mapping: 0 - Condition 1 - Job Failure 2 - Job Complete

alertFormatstringOptional

alertFormatValuestringOptional

alertMsgstringOptional

batchNamestringOptional

addRuleDetailsbooleanOptional

403

Forbidden. No access to dataset

application/json

post/v3/alerts

POST /v3/alerts HTTP/1.1
Host: <host-name>
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "dataset": "text",
  "alertNm": "text",
  "alertCond": "text",
  "alertFormat": "text",
  "alertFormatValue": "text",
  "alertMsg": "text",
  "batchName": "text",
  "addRuleDetails": true,
  "alertTypes": [
    "CONDITION"
  ]
}

{
  "dataset": "text",
  "alertNm": "text",
  "alertCond": "text",
  "alertFormat": "text",
  "alertFormatValue": "text",
  "alertMsg": "text",
  "batchName": "text",
  "addRuleDetails": true,
  "alertTypes": [
    "CONDITION"
  ]
}

List all alerts and their details for a given dataset

get

Returns a list of all alerts and their details for a given dataset. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Path parameters

datasetstringRequired

Dataset name

Responses

200

List of alerts by dataset

application/json

datasetstringOptional

alertNmstringOptional

alertCondstringOptional

alertTriggerTypeinteger · int32Write-onlyOptionalDeprecated

Deprecated: Use alertTypes field instead. Alert trigger type mapping: 0 - Condition 1 - Job Failure 2 - Job Complete

alertFormatstringOptional

alertFormatValuestringOptional

alertMsgstringOptional

batchNamestringOptional

addRuleDetailsbooleanOptional

403

User does not have access to the dataset

application/json

get/v3/alerts/{dataset}

GET /v3/alerts/{dataset} HTTP/1.1
Host: <host-name>
Accept: */*

[
  {
    "dataset": "text",
    "alertNm": "text",
    "alertCond": "text",
    "alertFormat": "text",
    "alertFormatValue": "text",
    "alertMsg": "text",
    "batchName": "text",
    "addRuleDetails": true,
    "alertTypes": [
      "CONDITION"
    ]
  }
]

Retrieve the details of a given alert

get

Retrieves the details of a given alert. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Path parameters

datasetstringRequired

Dataset name

alertNamestringRequired

Alert name

Responses

200

Alert by dataset and alertName

application/json

datasetstringOptional

alertNmstringOptional

alertCondstringOptional

alertTriggerTypeinteger · int32Write-onlyOptionalDeprecated

Deprecated: Use alertTypes field instead. Alert trigger type mapping: 0 - Condition 1 - Job Failure 2 - Job Complete

alertFormatstringOptional

alertFormatValuestringOptional

alertMsgstringOptional

batchNamestringOptional

addRuleDetailsbooleanOptional

403

User does not have access to the dataset

application/json

get/v3/alerts/{dataset}/{alertName}

GET /v3/alerts/{dataset}/{alertName} HTTP/1.1
Host: <host-name>
Accept: */*

{
  "dataset": "text",
  "alertNm": "text",
  "alertCond": "text",
  "alertFormat": "text",
  "alertFormatValue": "text",
  "alertMsg": "text",
  "batchName": "text",
  "addRuleDetails": true,
  "alertTypes": [
    "CONDITION"
  ]
}

Delete an alert

delete

Delete a given alert. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Path parameters

datasetstringRequired

Dataset name

alertNamestringRequired

Alert name

Responses

200

Alert deleted

No content

403

User does not have access to the dataset

application/json

delete/v3/alerts/{dataset}/{alertName}

DELETE /v3/alerts/{dataset}/{alertName} HTTP/1.1
Host: <host-name>
Accept: */*

No content

List the alert notifications for a given dataset

get

Returns a list of alert notifications for a given dataset. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Path parameters

datasetstringRequired

Dataset name

Query parameters

runDatestring · date-timeOptional

Run id

Responses

200

List of alerts notifications by dataset

application/json

datasetstringOptional

runIdstring · date-timeOptional

alertNmstringOptional

alertCondstringOptional

alertFormatstringOptional

alertFormatValuestringOptional

alertMsgstringOptional

alertOutputIdinteger · int32Optional

updtTsstring · date-timeOptional

403

User does not have access to the dataset

application/json

get/v3/alerts/{dataset}/notifications

GET /v3/alerts/{dataset}/notifications HTTP/1.1
Host: <host-name>
Accept: */*

[
  {
    "dataset": "text",
    "runId": "2026-07-12T01:22:13.032Z",
    "alertNm": "text",
    "alertCond": "text",
    "alertFormat": "text",
    "alertFormatValue": "text",
    "alertMsg": "text",
    "alertOutputId": 1,
    "updtTs": "2026-07-12T01:22:13.032Z",
    "alertTypes": [
      "CONDITION"
    ]
  }
]

List the alert notifications for a given Job ID

get

Returns a list of alert notifications for a given Job ID.

Query parameters

jobIdinteger · int32Optional

Job Id

jobUUIDstring · uuidOptional

Job UUID

Responses

200

List of alerts notifications by jobId

application/json

datasetstringOptional

runIdstring · date-timeOptional

alertNmstringOptional

alertCondstringOptional

alertFormatstringOptional

alertFormatValuestringOptional

alertMsgstringOptional

alertOutputIdinteger · int32Optional

updtTsstring · date-timeOptional

403

User does not have access to the dataset

application/json

404

Job not found

get/v3/alerts/notifications

GET /v3/alerts/notifications HTTP/1.1
Host: <host-name>
Accept: */*

[
  {
    "dataset": "text",
    "runId": "2026-07-12T01:22:13.032Z",
    "alertNm": "text",
    "alertCond": "text",
    "alertFormat": "text",
    "alertFormatValue": "text",
    "alertMsg": "text",
    "alertOutputId": 1,
    "updtTs": "2026-07-12T01:22:13.032Z",
    "alertTypes": [
      "CONDITION"
    ]
  }
]

Last updated 1 month ago

Was this helpful?