Lists uptime checks - Gorelo Documentation

GET

uptime

Lists uptime checks

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

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

fetch('https://api.usw.gorelo.io/v1/uptime', 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/uptime",
  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/uptime"

	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/uptime")

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",
      "Description": "<string>",
      "Type": {
        "Id": 1,
        "Name": "<string>"
      },
      "Target": {
        "Ip": "8.8.8.8",
        "Port": 443,
        "Url": "https://www.google.com"
      },
      "AdoptClientAssets": true,
      "ClientId": 123,
      "LocationId": 123,
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "Frequency": 123,
      "NumberOfRetriesAfterFailure": 123,
      "RegionId": 123,
      "IspConnectionLink": "<string>",
      "TagIds": [
        123
      ],
      "MaintenanceMode": {
        "Enabled": true,
        "StartDateTime": "2023-11-07T05:31:56Z",
        "DurationInMinutes": 123,
        "Reason": "<string>"
      },
      "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>"
    }
  ]
}

التفويضات

X-API-Key

string

header

مطلوب

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.

معلمات الاستعلام

Cursor

string

Opaque pagination cursor from a previous page; omit for the first page.

PageSize

integer<int32>

افتراضي:50

Number of items per page, 1-200 (default 50). Out of range is rejected, not clamped.

ClientIds

string

Comma-separated client ids to include. Omit for every client.

TypeIds

string

Comma-separated check type ids to include: 1 ICMP, 2 HTTP, 3 TCP.

TagIds

string

Comma-separated tag ids. A check is included if it carries any one of them.

Query

string

Keyword matched against the check description. Up to 200 characters.

الاستجابة

StatusCode

enum<integer>

الخيارات المتاحة:

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 uptime checks

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

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

fetch('https://api.usw.gorelo.io/v1/uptime', 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/uptime",
  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/uptime"

	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/uptime")

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",
      "Description": "<string>",
      "Type": {
        "Id": 1,
        "Name": "<string>"
      },
      "Target": {
        "Ip": "8.8.8.8",
        "Port": 443,
        "Url": "https://www.google.com"
      },
      "AdoptClientAssets": true,
      "ClientId": 123,
      "LocationId": 123,
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "Frequency": 123,
      "NumberOfRetriesAfterFailure": 123,
      "RegionId": 123,
      "IspConnectionLink": "<string>",
      "TagIds": [
        123
      ],
      "MaintenanceMode": {
        "Enabled": true,
        "StartDateTime": "2023-11-07T05:31:56Z",
        "DurationInMinutes": 123,
        "Reason": "<string>"
      },
      "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>"
    }
  ]
}