Create alert

cURL

curl --request POST \
  --url https://us.infisical.com/api/v1/alerts \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "resourceType": "<string>",
  "eventType": "<string>",
  "channels": [
    {
      "name": "<string>",
      "config": {},
      "enabled": true,
      "recipients": [
        {
          "principalId": "<string>"
        }
      ]
    }
  ],
  "description": "<string>",
  "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "condition": "<unknown>",
  "enabled": true,
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://us.infisical.com/api/v1/alerts"

payload = {
    "name": "<string>",
    "resourceType": "<string>",
    "eventType": "<string>",
    "channels": [
        {
            "name": "<string>",
            "config": {},
            "enabled": True,
            "recipients": [{ "principalId": "<string>" }]
        }
    ],
    "description": "<string>",
    "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "condition": "<unknown>",
    "enabled": True,
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    resourceType: '<string>',
    eventType: '<string>',
    channels: [
      {
        name: '<string>',
        config: {},
        enabled: true,
        recipients: [{principalId: '<string>'}]
      }
    ],
    description: '<string>',
    resourceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    condition: '<unknown>',
    enabled: true,
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://us.infisical.com/api/v1/alerts', 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.infisical.com/api/v1/alerts",
  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>',
    'resourceType' => '<string>',
    'eventType' => '<string>',
    'channels' => [
        [
                'name' => '<string>',
                'config' => [
                                
                ],
                'enabled' => true,
                'recipients' => [
                                [
                                                                'principalId' => '<string>'
                                ]
                ]
        ]
    ],
    'description' => '<string>',
    'resourceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'condition' => '<unknown>',
    'enabled' => true,
    'projectId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://us.infisical.com/api/v1/alerts"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"resourceType\": \"<string>\",\n  \"eventType\": \"<string>\",\n  \"channels\": [\n    {\n      \"name\": \"<string>\",\n      \"config\": {},\n      \"enabled\": true,\n      \"recipients\": [\n        {\n          \"principalId\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"condition\": \"<unknown>\",\n  \"enabled\": true,\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	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.infisical.com/api/v1/alerts")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"resourceType\": \"<string>\",\n  \"eventType\": \"<string>\",\n  \"channels\": [\n    {\n      \"name\": \"<string>\",\n      \"config\": {},\n      \"enabled\": true,\n      \"recipients\": [\n        {\n          \"principalId\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"condition\": \"<unknown>\",\n  \"enabled\": true,\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/alerts")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"resourceType\": \"<string>\",\n  \"eventType\": \"<string>\",\n  \"channels\": [\n    {\n      \"name\": \"<string>\",\n      \"config\": {},\n      \"enabled\": true,\n      \"recipients\": [\n        {\n          \"principalId\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"condition\": \"<unknown>\",\n  \"enabled\": true,\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "alert": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "resourceType": "<string>",
    "resourceId": "<string>",
    "eventType": "<string>",
    "triggerType": "<string>",
    "enabled": true,
    "orgId": "<string>",
    "projectId": "<string>",
    "channels": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "channelType": "<string>",
        "enabled": true,
        "config": {},
        "recipients": [
          {
            "principalType": "<string>",
            "principalId": "<string>"
          }
        ]
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "condition": null,
    "resourceName": "<string>",
    "filters": {},
    "lastRun": {
      "timestamp": "2023-11-07T05:31:56Z",
      "status": "success"
    }
  }
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

POST

api

alerts

cURL

curl --request POST \
  --url https://us.infisical.com/api/v1/alerts \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "resourceType": "<string>",
  "eventType": "<string>",
  "channels": [
    {
      "name": "<string>",
      "config": {},
      "enabled": true,
      "recipients": [
        {
          "principalId": "<string>"
        }
      ]
    }
  ],
  "description": "<string>",
  "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "condition": "<unknown>",
  "enabled": true,
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://us.infisical.com/api/v1/alerts"

payload = {
    "name": "<string>",
    "resourceType": "<string>",
    "eventType": "<string>",
    "channels": [
        {
            "name": "<string>",
            "config": {},
            "enabled": True,
            "recipients": [{ "principalId": "<string>" }]
        }
    ],
    "description": "<string>",
    "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "condition": "<unknown>",
    "enabled": True,
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    resourceType: '<string>',
    eventType: '<string>',
    channels: [
      {
        name: '<string>',
        config: {},
        enabled: true,
        recipients: [{principalId: '<string>'}]
      }
    ],
    description: '<string>',
    resourceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    condition: '<unknown>',
    enabled: true,
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://us.infisical.com/api/v1/alerts', 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.infisical.com/api/v1/alerts",
  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>',
    'resourceType' => '<string>',
    'eventType' => '<string>',
    'channels' => [
        [
                'name' => '<string>',
                'config' => [
                                
                ],
                'enabled' => true,
                'recipients' => [
                                [
                                                                'principalId' => '<string>'
                                ]
                ]
        ]
    ],
    'description' => '<string>',
    'resourceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'condition' => '<unknown>',
    'enabled' => true,
    'projectId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://us.infisical.com/api/v1/alerts"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"resourceType\": \"<string>\",\n  \"eventType\": \"<string>\",\n  \"channels\": [\n    {\n      \"name\": \"<string>\",\n      \"config\": {},\n      \"enabled\": true,\n      \"recipients\": [\n        {\n          \"principalId\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"condition\": \"<unknown>\",\n  \"enabled\": true,\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	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.infisical.com/api/v1/alerts")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"resourceType\": \"<string>\",\n  \"eventType\": \"<string>\",\n  \"channels\": [\n    {\n      \"name\": \"<string>\",\n      \"config\": {},\n      \"enabled\": true,\n      \"recipients\": [\n        {\n          \"principalId\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"condition\": \"<unknown>\",\n  \"enabled\": true,\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/alerts")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"resourceType\": \"<string>\",\n  \"eventType\": \"<string>\",\n  \"channels\": [\n    {\n      \"name\": \"<string>\",\n      \"config\": {},\n      \"enabled\": true,\n      \"recipients\": [\n        {\n          \"principalId\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"condition\": \"<unknown>\",\n  \"enabled\": true,\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "alert": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "resourceType": "<string>",
    "resourceId": "<string>",
    "eventType": "<string>",
    "triggerType": "<string>",
    "enabled": true,
    "orgId": "<string>",
    "projectId": "<string>",
    "channels": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "channelType": "<string>",
        "enabled": true,
        "config": {},
        "recipients": [
          {
            "principalType": "<string>",
            "principalId": "<string>"
          }
        ]
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "condition": null,
    "resourceName": "<string>",
    "filters": {},
    "lastRun": {
      "timestamp": "2023-11-07T05:31:56Z",
      "status": "success"
    }
  }
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

Body

application/json

name

string

required

The name of the alert.

Required string length: 1 - 255

resourceType

string

required

The type of resource the alert watches, for example cert-manager.application.

Required string length: 1 - 255

eventType

string

required

The event that triggers the alert, for example cert-manager.application.certificate.expiry.

Required string length: 1 - 255

channels

object[]

required

The channels the alert notifies. Each is email, Slack, webhook, or PagerDuty.

Required array length: 1 - 10 elements

Show child attributes

description

string

The description of the alert.

Maximum string length: 1000

resourceId

string<uuid> | null

The ID of the resource the alert watches. Set to null to watch every resource of this type, where the resource type supports it.

condition

any

The settings of the alert's event, for example alertBefore on an expiry event. The accepted fields depend on eventType.

enabled

boolean

Whether the alert is enabled. Defaults to true.

projectId

string<uuid> | null

The ID of the project to create the alert in. Optional when the resource belongs to a project.

Response

Default Response

alert

object

required

Show child attributes

Get started

Organization

Project

Shared

Identity auth

Secrets Management

Certificate Management

Secret sharing

Agent Vault

Key Management Service (KMS)

KMIP servers

Gateways

External migrations

Other

Body

Response