Get an Alert Notification Channel

GET

organizations

{organizationId}

notification-channels

{notificationChannelId}

Get an Alert Notification Channel

curl --request GET \
  --url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/notification-channels/{notificationChannelId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/notification-channels/{notificationChannelId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/notification-channels/{notificationChannelId}', 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}/notification-channels/{notificationChannelId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/notification-channels/{notificationChannelId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/notification-channels/{notificationChannelId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/notification-channels/{notificationChannelId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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"
  },
  "definition": "<unknown>",
  "entityId": "<string>",
  "entityType": "<string>",
  "id": "<string>",
  "isShared": true,
  "name": "<string>",
  "organizationId": "<string>",
  "type": "<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>",
  "workspaceId": "<string>"
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

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 Notification Channel belongs.

notificationChannelId

string

required

The ID of the Notification Channel to get.

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

definition

any

required

The notification channel's definition.

entityId

string

required

The entity ID the notification channel is scoped to.

entityType

string

required

The type of entity the notification channel is scoped to.

string

required

The notification channel's ID.

isShared

boolean

required

When entity type is scoped to ORGANIZATION or WORKSPACE, this determines if child entities can access this notification channel.

name

string

required

The notification channel's name.

organizationId

string

required

The organization ID the notification channel is scoped to.

type

string

required

The notification channel's type.

updatedAt

string<date-time>

required

The time when the alert was 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 deployment ID the notification channel is scoped to.

entityName

string

The name of the entity the notification channel is scoped to.

workspaceId

string

The workspace ID the notification channel is scoped to.

⌘I

Get an Alert Notification Channel

curl --request GET \
  --url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/notification-channels/{notificationChannelId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/notification-channels/{notificationChannelId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/notification-channels/{notificationChannelId}', 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}/notification-channels/{notificationChannelId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/notification-channels/{notificationChannelId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/notification-channels/{notificationChannelId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/notification-channels/{notificationChannelId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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"
  },
  "definition": "<unknown>",
  "entityId": "<string>",
  "entityType": "<string>",
  "id": "<string>",
  "isShared": true,
  "name": "<string>",
  "organizationId": "<string>",
  "type": "<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>",
  "workspaceId": "<string>"
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}