Lists alerts for the authenticated service provider.

GET

alerts

curl --request GET \
  --url https://api.usw.gorelo.io/v1/alerts \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.usw.gorelo.io/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://api.usw.gorelo.io/v1/alerts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/alerts"

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

	req.Header.Add("X-API-Key", "<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.usw.gorelo.io/v1/alerts")

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

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

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": [
    {
      "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "Title": "<string>",
      "Type": {
        "Id": 1,
        "Name": "<string>"
      },
      "Severity": {
        "Id": 1,
        "Name": "<string>"
      },
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "Message": "<string>",
      "ClientId": 123,
      "AgentAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "DeviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "CustomAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "CheckId": "<string>",
      "UptimeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "UptimeCheckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "TicketId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ContractId": 123,
      "DomainId": 123,
      "DismissedOn": "2023-11-07T05:31:56Z",
      "DismissedBy": 123,
      "CreatedOn": "2023-11-07T05:31:56Z",
      "UpdatedOn": "2023-11-07T05:31:56Z"
    }
  ],
  "DataContext": {
    "Pagination": {
      "NextCursor": "<string>",
      "PreviousCursor": "<string>",
      "HasMore": true,
      "HasPrevious": true,
      "TotalCount": 123
    }
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

Autorisations

X-API-Key

string

header

requis

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Paramètres de requête

Cursor

string

Cursor from a previous page.

PageSize

integer<int32>

défaut:50

Alerts per page, 1-200. Defaults to 50.

SortOrder

string

défaut:desc

desc (default, newest first) or asc. Sorted by CreatedOn.

StatusIds

string

Comma-separated status ids: New=1, Dismissed=2, Ticketed=3. Any other id is a 400.

TypeIds

string

Comma-separated type ids: Uptime=1, API=2, Script=3, External=4, Slide=5, Huntress=6, Error Event Log=7, Disk Usage=8, Connectivity=9, Process=10, Service=11, Antivirus=12, Redfish=13, CPU=14, Memory=15, Ping=16, Windows Updates=17, Warranty Expiration=18, Domain Expiration=19, Contract Expiration=20. 7-17 are device-check alerts, identified by their check type rather than by how the alert was raised. 18-20 carry no device or check; Contract and Domain carry a subject id, Warranty does not. 0 (N/A) matches an alert this scale cannot name. Any id outside 0-20 is a 400.

ClientIds

string

Comma-separated client ids. An alert type that carries no client id never matches this filter.

DeviceIds

string

Deprecated alias of agentAssetIds. Still accepted; ignored when agentAssetIds is supplied.

CreatedSince

string<date-time>

Keeps only alerts raised at or after this instant (UTC).

CreatedBefore

string<date-time>

Keeps only alerts raised strictly before this instant (UTC).

AgentAssetIds

string

Comma-separated agent asset ids (guids).

CustomAssetIds

string

Comma-separated custom asset ids (guids). Matches the alerts about a custom asset: Warranty Expiration alerts, and API alerts posted with a CustomAssetId.

UptimeIds

string

Comma-separated uptime ids (guids).

Réponse

StatusCode

enum<integer>

Options disponibles:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object[] | null

Show child attributes

DataContext

object

The DataContext of a cursor-paginated success response: carries the paging metadata for the returned page.

Show child attributes

Notifications

object[]

Show child attributes

⌘I

Lists alerts for the authenticated service provider.

curl --request GET \
  --url https://api.usw.gorelo.io/v1/alerts \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.usw.gorelo.io/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://api.usw.gorelo.io/v1/alerts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/alerts"

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

	req.Header.Add("X-API-Key", "<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.usw.gorelo.io/v1/alerts")

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

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

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": [
    {
      "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "Title": "<string>",
      "Type": {
        "Id": 1,
        "Name": "<string>"
      },
      "Severity": {
        "Id": 1,
        "Name": "<string>"
      },
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "Message": "<string>",
      "ClientId": 123,
      "AgentAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "DeviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "CustomAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "CheckId": "<string>",
      "UptimeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "UptimeCheckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "TicketId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ContractId": 123,
      "DomainId": 123,
      "DismissedOn": "2023-11-07T05:31:56Z",
      "DismissedBy": 123,
      "CreatedOn": "2023-11-07T05:31:56Z",
      "UpdatedOn": "2023-11-07T05:31:56Z"
    }
  ],
  "DataContext": {
    "Pagination": {
      "NextCursor": "<string>",
      "PreviousCursor": "<string>",
      "HasMore": true,
      "HasPrevious": true,
      "TotalCount": 123
    }
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}