Update

Update an existing alert configuration. The config can be identified by either ID or FQN.

PUT /api/alerts/v1

Update

cURL

curl --request PUT \
  --url https://developer.synq.io/api/alerts/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": {
    "fqn": "<string>"
  },
  "name": "<string>",
  "trigger": {
    "parts": [
      {
        "operand": "QUERY_OPERAND_UNSPECIFIED",
        "parts": [
          {
            "identifierList": {
              "identifiers": [
                {
                  "airflowDag": {
                    "integrationId": "<string>",
                    "dagId": "<string>"
                  }
                }
              ]
            }
          }
        ]
      }
    ]
  },
  "targets": [
    {
      "email": {
        "recipientEmails": [
          "[e-mail]"
        ]
      }
    }
  ],
  "settings": {
    "entityFailure": {
      "ongoing": {
        "disabled": {}
      },
      "severities": [
        "SEVERITY_UNSPECIFIED"
      ],
      "notifyUpstream": true,
      "allowSqlTestAuditLink": true
    }
  },
  "owner": {
    "ownerPath": "<string>",
    "ownershipId": "<string>"
  }
}
'

200

{
  "alert": {
    "trigger": {
      "parts": [
        {
          "operand": "QUERY_OPERAND_UNSPECIFIED",
          "parts": [
            {
              "identifierList": {
                "identifiers": [
                  {
                    "airflowDag": {
                      "integrationId": "<string>",
                      "dagId": "<string>"
                    }
                  }
                ]
              }
            }
          ]
        }
      ]
    },
    "settings": {
      "entityFailure": {
        "ongoing": {
          "disabled": {}
        },
        "severities": [
          "SEVERITY_UNSPECIFIED"
        ],
        "notifyUpstream": true,
        "allowSqlTestAuditLink": true
      }
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "fqn": "<string>",
    "targets": [
      {
        "email": {
          "recipientEmails": [
            "[e-mail]"
          ]
        }
      }
    ],
    "owner": {
      "ownerPath": "<string>",
      "ownershipId": "<string>"
    },
    "isDisabled": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

UpdateRequest updates an existing alert configuration. The config can be identified by either ID or FQN.

identifier · fqn · object · required

Identifier for the config to update.

fqn

id

Show child attributes

name · string | null

Human-readable name for the alert configuration.

Required string length: 1 - 255

trigger · EntityGroupQuery · object

Query that defines which entities can trigger this alert.

Show child attributes

targets · (email · object | ms_teams · object | owner · object | slack · object | webhook · object)[]

Targets where alerts will be sent.

Minimum array length: 1

AlertingTarget represents a destination where alert notifications will be sent. Each target type has its own specific configuration requirements.

email

ms_teams

owner

slack

webhook

Show child attributes

settings · entity_failure · object

Additional settings for the specific alert type.

entity_failure

schema_change

Show child attributes

owner · Owner · object

Optional owner information for the alert configuration.

Show child attributes

Response

200 - application/json

Success

UpdateResponse returns the updated alert configuration.

alert · Alert · object · required

The alert configuration that was updated.

Show child attributes