Update an alert

curl --request POST \
  --url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "notificationChannelIds": [
    "<string>"
  ],
  "rules": {
    "patternMatches": [
      {
        "values": [
          "<string>"
        ]
      }
    ],
    "properties": {
      "dagDurationSeconds": 43230
    }
  }
}
'

import requests

url = "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId}"

payload = {
    "name": "<string>",
    "notificationChannelIds": ["<string>"],
    "rules": {
        "patternMatches": [{ "values": ["<string>"] }],
        "properties": { "dagDurationSeconds": 43230 }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    notificationChannelIds: ['<string>'],
    rules: {
      patternMatches: [{values: ['<string>']}],
      properties: {dagDurationSeconds: 43230}
    }
  })
};

fetch('https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'notificationChannelIds' => [
        '<string>'
    ],
    'rules' => [
        'patternMatches' => [
                [
                                'values' => [
                                                                '<string>'
                                ]
                ]
        ],
        'properties' => [
                'dagDurationSeconds' => 43230
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"notificationChannelIds\": [\n    \"<string>\"\n  ],\n  \"rules\": {\n    \"patternMatches\": [\n      {\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"properties\": {\n      \"dagDurationSeconds\": 43230\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"notificationChannelIds\": [\n    \"<string>\"\n  ],\n  \"rules\": {\n    \"patternMatches\": [\n      {\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"properties\": {\n      \"dagDurationSeconds\": 43230\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"notificationChannelIds\": [\n    \"<string>\"\n  ],\n  \"rules\": {\n    \"patternMatches\": [\n      {\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"properties\": {\n      \"dagDurationSeconds\": 43230\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "createdAt": "2022-11-22T04:37:12Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "entityId": "<string>",
  "entityType": "DEPLOYMENT",
  "id": "<string>",
  "name": "<string>",
  "organizationId": "<string>",
  "rules": {
    "properties": "<unknown>",
    "patternMatches": [
      {
        "entityType": "DAG_ID TASK_ID",
        "operatorType": "IS IS_NOT INCLUDES EXCLUDES",
        "values": [
          "<string>"
        ]
      }
    ]
  },
  "updatedAt": "2022-11-22T04:37:12Z",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "deploymentId": "<string>",
  "entityName": "<string>",
  "notificationChannels": [
    {
      "createdAt": "2022-11-22T04:37:12Z",
      "definition": "<unknown>",
      "entityId": "<string>",
      "id": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "updatedAt": "2022-11-22T04:37:12Z",
      "deploymentId": "<string>",
      "workspaceId": "<string>"
    }
  ],
  "workspaceId": "<string>"
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

POST

organizations

{organizationId}

alerts

{alertId}

Update an alert

curl --request POST \
  --url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "notificationChannelIds": [
    "<string>"
  ],
  "rules": {
    "patternMatches": [
      {
        "values": [
          "<string>"
        ]
      }
    ],
    "properties": {
      "dagDurationSeconds": 43230
    }
  }
}
'

import requests

url = "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId}"

payload = {
    "name": "<string>",
    "notificationChannelIds": ["<string>"],
    "rules": {
        "patternMatches": [{ "values": ["<string>"] }],
        "properties": { "dagDurationSeconds": 43230 }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    notificationChannelIds: ['<string>'],
    rules: {
      patternMatches: [{values: ['<string>']}],
      properties: {dagDurationSeconds: 43230}
    }
  })
};

fetch('https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'notificationChannelIds' => [
        '<string>'
    ],
    'rules' => [
        'patternMatches' => [
                [
                                'values' => [
                                                                '<string>'
                                ]
                ]
        ],
        'properties' => [
                'dagDurationSeconds' => 43230
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"notificationChannelIds\": [\n    \"<string>\"\n  ],\n  \"rules\": {\n    \"patternMatches\": [\n      {\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"properties\": {\n      \"dagDurationSeconds\": 43230\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"notificationChannelIds\": [\n    \"<string>\"\n  ],\n  \"rules\": {\n    \"patternMatches\": [\n      {\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"properties\": {\n      \"dagDurationSeconds\": 43230\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/alerts/{alertId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"notificationChannelIds\": [\n    \"<string>\"\n  ],\n  \"rules\": {\n    \"patternMatches\": [\n      {\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"properties\": {\n      \"dagDurationSeconds\": 43230\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "createdAt": "2022-11-22T04:37:12Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "entityId": "<string>",
  "entityType": "DEPLOYMENT",
  "id": "<string>",
  "name": "<string>",
  "organizationId": "<string>",
  "rules": {
    "properties": "<unknown>",
    "patternMatches": [
      {
        "entityType": "DAG_ID TASK_ID",
        "operatorType": "IS IS_NOT INCLUDES EXCLUDES",
        "values": [
          "<string>"
        ]
      }
    ]
  },
  "updatedAt": "2022-11-22T04:37:12Z",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "deploymentId": "<string>",
  "entityName": "<string>",
  "notificationChannels": [
    {
      "createdAt": "2022-11-22T04:37:12Z",
      "definition": "<unknown>",
      "entityId": "<string>",
      "id": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "updatedAt": "2022-11-22T04:37:12Z",
      "deploymentId": "<string>",
      "workspaceId": "<string>"
    }
  ],
  "workspaceId": "<string>"
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

Authorizations

Authorization

string

header

required

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

Path Parameters

organizationId

string

required

The ID of the Organization to which the alert belongs to.

alertId

string

required

The ID of the alert to update.

Body

application/json

The request body for updating an alert.

name

string

The alert's name.

Required string length: 1 - 500

notificationChannelIds

string[]

The notification channels to send alerts to.

Minimum array length: 1

rules

object

Show child attributes

severity

enum<string>

The alert's severity.

Available options:

INFO,

WARNING,

CRITICAL

type

enum<string>

The alert's type.

Available options:

DAG_SUCCESS,

DAG_FAILURE,

DAG_DURATION,

DAG_TIMELINESS,

TASK_DURATION,

TASK_FAILURE

Response

createdAt

string<date-time>

required

The time when the alert was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

createdBy

object

required

Show child attributes

entityId

string

required

The ID of the entity the alert is associated with.

entityType

enum<string>

required

The type of entity the alert is associated with.

Available options:

DEPLOYMENT

string

required

The alert's ID.

name

string

required

The alert's name.

organizationId

string

required

The ID of the organization the alert is associated with.

rules

object

required

Show child attributes

severity

enum<string>

required

The alert's severity.

Available options:

INFO,

WARNING,

CRITICAL

type

enum<string>

required

The alert's type.

Available options:

DAG_SUCCESS,

DAG_FAILURE,

DAG_DURATION,

DAG_TIMELINESS,

TASK_DURATION,

TASK_FAILURE,

DATA_PRODUCT_SLA,

DATA_PRODUCT_PROACTIVE_FAILURE,

DATA_PRODUCT_PROACTIVE_SLA,

AIRFLOW_DB_STORAGE_UNUSUALLY_HIGH,

DEPRECATED_RUNTIME_VERSION,

JOB_SCHEDULING_DISABLED,

WORKER_QUEUE_AT_CAPACITY

updatedAt

string<date-time>

required

The time when the alert was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

updatedBy

object

required

Show child attributes

deploymentId

string

The ID of the deployment the alert is associated with.

entityName

string

The name of the entity the alert is associated with.

notificationChannels

object[]

The notification channels to send alerts to.

Show child attributes

workspaceId

string

The ID of the workspace the alert is associated with.

⌘I

Astro API v1beta1

Platform API

IAM API

Update an alert

Authorizations

Path Parameters

Body

Response