PingOne Platform APIs

Update Alert Channel

 

PUT {{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}}

The PUT {{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}} operation updates an alert channel for a specified environment.

Prerequisites

  • Refer to Alerting for important overview information.

Request Model

For property descriptions, refer to Alert channel data model.

Property Type Required?

addresses

String[]

Required

alertName

String

Optional

channelType

String

Required

excludeAlertTypes

String[]

Optional

includeSeverities

String[]

Optional

includeAlertTypes

String[]

Optional

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "channelType":"EMAIL",
    "alertName":"Cert Expired Alert",
    "includeSeverities":["WARNING"],
    "includeAlertTypes":["CERTIFICATE_EXPIRED"],
    "excludeAlertTypes":[],
    "addresses":["tom@example.com"]
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data-raw '{
    "channelType":"EMAIL",
    "alertName":"Cert Expired Alert",
    "includeSeverities":["WARNING"],
    "includeAlertTypes":["CERTIFICATE_EXPIRED"],
    "excludeAlertTypes":[],
    "addresses":["tom@example.com"]
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""channelType"":""EMAIL""," + "\n" +
@"    ""alertName"":""Cert Expired Alert""," + "\n" +
@"    ""includeSeverities"":[""WARNING""]," + "\n" +
@"    ""includeAlertTypes"":[""CERTIFICATE_EXPIRED""]," + "\n" +
@"    ""excludeAlertTypes"":[]," + "\n" +
@"    ""addresses"":[""tom@example.com""]" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}}"
  method := "PUT"

  payload := strings.NewReader(`{
    "channelType":"EMAIL",
    "alertName":"Cert Expired Alert",
    "includeSeverities":["WARNING"],
    "includeAlertTypes":["CERTIFICATE_EXPIRED"],
    "excludeAlertTypes":[],
    "addresses":["tom@example.com"]
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
PUT /environments/{{envID}}/alertChannels/{{alertChannelID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "channelType":"EMAIL",
    "alertName":"Cert Expired Alert",
    "includeSeverities":["WARNING"],
    "includeAlertTypes":["CERTIFICATE_EXPIRED"],
    "excludeAlertTypes":[],
    "addresses":["tom@example.com"]
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"channelType\":\"EMAIL\",\n    \"alertName\":\"Cert Expired Alert\",\n    \"includeSeverities\":[\"WARNING\"],\n    \"includeAlertTypes\":[\"CERTIFICATE_EXPIRED\"],\n    \"excludeAlertTypes\":[],\n    \"addresses\":[\"tom@example.com\"]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}}")
  .method("PUT", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}}",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "channelType": "EMAIL",
    "alertName": "Cert Expired Alert",
    "includeSeverities": [
      "WARNING"
    ],
    "includeAlertTypes": [
      "CERTIFICATE_EXPIRED"
    ],
    "excludeAlertTypes": [],
    "addresses": [
      "tom@example.com"
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "channelType": "EMAIL",
    "alertName": "Cert Expired Alert",
    "includeSeverities": [
      "WARNING"
    ],
    "includeAlertTypes": [
      "CERTIFICATE_EXPIRED"
    ],
    "excludeAlertTypes": [],
    "addresses": [
      "tom@example.com"
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}}"

payload = json.dumps({
  "channelType": "EMAIL",
  "alertName": "Cert Expired Alert",
  "includeSeverities": [
    "WARNING"
  ],
  "includeAlertTypes": [
    "CERTIFICATE_EXPIRED"
  ],
  "excludeAlertTypes": [],
  "addresses": [
    "tom@example.com"
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}}');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "channelType":"EMAIL",\n    "alertName":"Cert Expired Alert",\n    "includeSeverities":["WARNING"],\n    "includeAlertTypes":["CERTIFICATE_EXPIRED"],\n    "excludeAlertTypes":[],\n    "addresses":["tom@example.com"]\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "channelType": "EMAIL",
  "alertName": "Cert Expired Alert",
  "includeSeverities": [
    "WARNING"
  ],
  "includeAlertTypes": [
    "CERTIFICATE_EXPIRED"
  ],
  "excludeAlertTypes": [],
  "addresses": [
    "tom@example.com"
  ]
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"channelType\":\"EMAIL\",\n    \"alertName\":\"Cert Expired Alert\",\n    \"includeSeverities\":[\"WARNING\"],\n    \"includeAlertTypes\":[\"CERTIFICATE_EXPIRED\"],\n    \"excludeAlertTypes\":[],\n    \"addresses\":[\"tom@example.com\"]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "PUT"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/alertChannels/c0bc4d2e-6d5a-46f1-892b-499e526a633a"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        }
    },
    "id": "c0bc4d2e-6d5a-46f1-892b-499e526a633a",
    "alertName": "Cert Expired Alert",
    "includeSeverities": [
        "WARNING"
    ],
    "includeAlertTypes": [
        "CERTIFICATE_EXPIRED"
    ],
    "addresses": [
        "tom@example.com"
    ],
    "channelType": "EMAIL"
}