Create alert settings
curl --request POST \
--url https://us.api.flexprice.io/v1/alerts/setting \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"config": {
"alert_enabled": true,
"critical": {
"threshold": "<string>"
},
"info": {
"threshold": "<string>"
},
"warning": {
"threshold": "<string>"
}
},
"entity_id": "<string>",
"parent_entity_id": "<string>"
}
'import requests
url = "https://us.api.flexprice.io/v1/alerts/setting"
payload = {
"config": {
"alert_enabled": True,
"critical": { "threshold": "<string>" },
"info": { "threshold": "<string>" },
"warning": { "threshold": "<string>" }
},
"entity_id": "<string>",
"parent_entity_id": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
config: {
alert_enabled: true,
critical: {threshold: '<string>'},
info: {threshold: '<string>'},
warning: {threshold: '<string>'}
},
entity_id: '<string>',
parent_entity_id: '<string>'
})
};
fetch('https://us.api.flexprice.io/v1/alerts/setting', 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://us.api.flexprice.io/v1/alerts/setting",
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([
'config' => [
'alert_enabled' => true,
'critical' => [
'threshold' => '<string>'
],
'info' => [
'threshold' => '<string>'
],
'warning' => [
'threshold' => '<string>'
]
],
'entity_id' => '<string>',
'parent_entity_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://us.api.flexprice.io/v1/alerts/setting"
payload := strings.NewReader("{\n \"config\": {\n \"alert_enabled\": true,\n \"critical\": {\n \"threshold\": \"<string>\"\n },\n \"info\": {\n \"threshold\": \"<string>\"\n },\n \"warning\": {\n \"threshold\": \"<string>\"\n }\n },\n \"entity_id\": \"<string>\",\n \"parent_entity_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://us.api.flexprice.io/v1/alerts/setting")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"alert_enabled\": true,\n \"critical\": {\n \"threshold\": \"<string>\"\n },\n \"info\": {\n \"threshold\": \"<string>\"\n },\n \"warning\": {\n \"threshold\": \"<string>\"\n }\n },\n \"entity_id\": \"<string>\",\n \"parent_entity_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/alerts/setting")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"alert_enabled\": true,\n \"critical\": {\n \"threshold\": \"<string>\"\n },\n \"info\": {\n \"threshold\": \"<string>\"\n },\n \"warning\": {\n \"threshold\": \"<string>\"\n }\n },\n \"entity_id\": \"<string>\",\n \"parent_entity_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"config": {
"alert_enabled": true,
"critical": {
"threshold": "<string>"
},
"info": {
"threshold": "<string>"
},
"warning": {
"threshold": "<string>"
}
},
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"enabled": true,
"entity_id": "<string>",
"environment_id": "<string>",
"id": "<string>",
"parent_entity_id": "<string>",
"parent_entity_type": "<string>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}{
"http_status_code": 123,
"message": "<string>"
}{
"http_status_code": 123,
"message": "<string>"
}AlertSettings
Create alert settings
Configure a subscription, line item, or group spend alert.
POST
/
alerts
/
setting
Create alert settings
curl --request POST \
--url https://us.api.flexprice.io/v1/alerts/setting \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"config": {
"alert_enabled": true,
"critical": {
"threshold": "<string>"
},
"info": {
"threshold": "<string>"
},
"warning": {
"threshold": "<string>"
}
},
"entity_id": "<string>",
"parent_entity_id": "<string>"
}
'import requests
url = "https://us.api.flexprice.io/v1/alerts/setting"
payload = {
"config": {
"alert_enabled": True,
"critical": { "threshold": "<string>" },
"info": { "threshold": "<string>" },
"warning": { "threshold": "<string>" }
},
"entity_id": "<string>",
"parent_entity_id": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
config: {
alert_enabled: true,
critical: {threshold: '<string>'},
info: {threshold: '<string>'},
warning: {threshold: '<string>'}
},
entity_id: '<string>',
parent_entity_id: '<string>'
})
};
fetch('https://us.api.flexprice.io/v1/alerts/setting', 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://us.api.flexprice.io/v1/alerts/setting",
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([
'config' => [
'alert_enabled' => true,
'critical' => [
'threshold' => '<string>'
],
'info' => [
'threshold' => '<string>'
],
'warning' => [
'threshold' => '<string>'
]
],
'entity_id' => '<string>',
'parent_entity_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://us.api.flexprice.io/v1/alerts/setting"
payload := strings.NewReader("{\n \"config\": {\n \"alert_enabled\": true,\n \"critical\": {\n \"threshold\": \"<string>\"\n },\n \"info\": {\n \"threshold\": \"<string>\"\n },\n \"warning\": {\n \"threshold\": \"<string>\"\n }\n },\n \"entity_id\": \"<string>\",\n \"parent_entity_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://us.api.flexprice.io/v1/alerts/setting")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"alert_enabled\": true,\n \"critical\": {\n \"threshold\": \"<string>\"\n },\n \"info\": {\n \"threshold\": \"<string>\"\n },\n \"warning\": {\n \"threshold\": \"<string>\"\n }\n },\n \"entity_id\": \"<string>\",\n \"parent_entity_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/alerts/setting")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"alert_enabled\": true,\n \"critical\": {\n \"threshold\": \"<string>\"\n },\n \"info\": {\n \"threshold\": \"<string>\"\n },\n \"warning\": {\n \"threshold\": \"<string>\"\n }\n },\n \"entity_id\": \"<string>\",\n \"parent_entity_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"config": {
"alert_enabled": true,
"critical": {
"threshold": "<string>"
},
"info": {
"threshold": "<string>"
},
"warning": {
"threshold": "<string>"
}
},
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"enabled": true,
"entity_id": "<string>",
"environment_id": "<string>",
"id": "<string>",
"parent_entity_id": "<string>",
"parent_entity_type": "<string>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}{
"http_status_code": 123,
"message": "<string>"
}{
"http_status_code": 123,
"message": "<string>"
}Authorizations
Enter your API key in the format x-api-key <api-key>*
Body
application/json
Alert settings
Show child attributes
Show child attributes
entity_id is the id of the monitored entity: subscription id, subscription_line_item id, or group id, matching entity_type.
Available options:
wallet, feature, subscription, subscription_line_item, group parent_entity_id is the subscription id that owns a line-item or group alert. Required when entity_type is "subscription_line_item" or "group"; omitted for subscription-level alerts.
Available options:
wallet, feature, subscription, subscription_line_item, group Response
Created
Show child attributes
Show child attributes
Available options:
wallet, feature, subscription, subscription_line_item, group Available options:
published, deleted, archived ⌘I

