Download alerts - Coralogix Developer Docs

Download alerts

curl --request GET \
  --url https://api.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/all/download \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/all/download"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/all/download', 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.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/all/download",
  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: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/all/download"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/all/download")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "content": "SGVsbG8gV29ybGQ=",
  "notFoundIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

Download alerts

curl --request GET \
  --url https://api.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/all/download \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/all/download"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/all/download', 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.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/all/download",
  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: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/all/download"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/all/download")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "content": "SGVsbG8gV29ybGQ=",
  "notFoundIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

API key authentication

Query Parameters

ids

string[]

Optional list of alert definition IDs to download. When empty, all accessible alert definitions are downloaded. IDs that are not found or not accessible are omitted from the download and reported in the response notFoundIds (no error is returned for them).

Maximum array length: 1000

Maximum string length: 36

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Example:

["123e4567-e89b-12d3-a456-426614174000"]

Response

A response containing the downloaded alert data

content

string<byte>

Base64-encoded binary data of the alert definitions

Example:

"SGVsbG8gV29ybGQ="

notFoundIds

string[]

Requested alert definition IDs that were not included in the download because they were not found or are not accessible. Populated on the first streamed message.

Maximum array length: 1000

Requested alert definition IDs that were not included in the download because they were not found or are not accessible. Populated on the first streamed message.

Maximum string length: 36

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Example:

["123e4567-e89b-12d3-a456-426614174000"]