Creates an uptime check. - Gorelo Documentation

POST

uptime

Creates an uptime check.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/uptime \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "TypeId": 1,
  "Target": {
    "Ip": "8.8.8.8",
    "Port": 443,
    "Url": "https://www.google.com"
  },
  "AdoptClientAssets": true,
  "ClientId": 123,
  "LocationId": 123,
  "Description": "<string>",
  "Frequency": 1,
  "NumberOfRetriesAfterFailure": 2,
  "RegionId": 1,
  "IspConnectionLink": "<string>",
  "TagIds": [
    123
  ]
}
'

import requests

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

payload = {
    "TypeId": 1,
    "Target": {
        "Ip": "8.8.8.8",
        "Port": 443,
        "Url": "https://www.google.com"
    },
    "AdoptClientAssets": True,
    "ClientId": 123,
    "LocationId": 123,
    "Description": "<string>",
    "Frequency": 1,
    "NumberOfRetriesAfterFailure": 2,
    "RegionId": 1,
    "IspConnectionLink": "<string>",
    "TagIds": [123]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+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-patch+json'},
  body: JSON.stringify({
    TypeId: 1,
    Target: {Ip: '8.8.8.8', Port: 443, Url: 'https://www.google.com'},
    AdoptClientAssets: true,
    ClientId: 123,
    LocationId: 123,
    Description: '<string>',
    Frequency: 1,
    NumberOfRetriesAfterFailure: 2,
    RegionId: 1,
    IspConnectionLink: '<string>',
    TagIds: [123]
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'TypeId' => 1,
    'Target' => [
        'Ip' => '8.8.8.8',
        'Port' => 443,
        'Url' => 'https://www.google.com'
    ],
    'AdoptClientAssets' => true,
    'ClientId' => 123,
    'LocationId' => 123,
    'Description' => '<string>',
    'Frequency' => 1,
    'NumberOfRetriesAfterFailure' => 2,
    'RegionId' => 1,
    'IspConnectionLink' => '<string>',
    'TagIds' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+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://api.usw.gorelo.io/v1/uptime"

	payload := strings.NewReader("{\n  \"TypeId\": 1,\n  \"Target\": {\n    \"Ip\": \"8.8.8.8\",\n    \"Port\": 443,\n    \"Url\": \"https://www.google.com\"\n  },\n  \"AdoptClientAssets\": true,\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"Description\": \"<string>\",\n  \"Frequency\": 1,\n  \"NumberOfRetriesAfterFailure\": 2,\n  \"RegionId\": 1,\n  \"IspConnectionLink\": \"<string>\",\n  \"TagIds\": [\n    123\n  ]\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+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://api.usw.gorelo.io/v1/uptime")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"TypeId\": 1,\n  \"Target\": {\n    \"Ip\": \"8.8.8.8\",\n    \"Port\": 443,\n    \"Url\": \"https://www.google.com\"\n  },\n  \"AdoptClientAssets\": true,\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"Description\": \"<string>\",\n  \"Frequency\": 1,\n  \"NumberOfRetriesAfterFailure\": 2,\n  \"RegionId\": 1,\n  \"IspConnectionLink\": \"<string>\",\n  \"TagIds\": [\n    123\n  ]\n}")
  .asString();

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::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"TypeId\": 1,\n  \"Target\": {\n    \"Ip\": \"8.8.8.8\",\n    \"Port\": 443,\n    \"Url\": \"https://www.google.com\"\n  },\n  \"AdoptClientAssets\": true,\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"Description\": \"<string>\",\n  \"Frequency\": 1,\n  \"NumberOfRetriesAfterFailure\": 2,\n  \"RegionId\": 1,\n  \"IspConnectionLink\": \"<string>\",\n  \"TagIds\": [\n    123\n  ]\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "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.

Corps

Uptime check details.

Request body for creating an uptime check. The owning service provider is resolved from the request context, not from the body.

TypeId

integer<int32>

What the check does: 1 ICMP, 2 HTTP, 3 TCP. Required.

Exemple:

1

Target

object

What an uptime check points at. Which fields are populated depends on the check type: ICMP uses Ip, TCP uses Ip and Port, HTTP uses Url. The others are null.

Show child attributes

AdoptClientAssets

boolean

Move unassigned devices whose public IP matches this check's address to the check's client. Only acted on for ICMP checks that carry both a client and a location; stored either way.

ClientId

integer<int64> | null

Identifier of the client the check belongs to. When supplied, LocationId is required with it.

LocationId

integer<int64> | null

Identifier of the client location the check belongs to.

Description

string | null

What the check watches, free text. Max 250 characters.

Frequency

integer<int32>

How often the check runs, in minutes. Required.

Exemple:

1

NumberOfRetriesAfterFailure

integer<int32> | null

How many times a failure is rechecked before the check counts as down. Defaults to 2.

Exemple:

2

RegionId

integer<int32>

Which monitoring region runs the check: 1 Seattle, 2 Sydney, 3 UK, 4 Frankfurt. Required.

Exemple:

1

IspConnectionLink

string | null

Link to the ISP or provider status page for this endpoint. Max 500 characters.

TagIds

integer<int64>[] | null

Identifiers of tags to apply to the check.

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

The identifier of the created uptime check.

Show child attributes

DataContext

object | null

Exemple:

null

Notifications

object[]

Show child attributes

⌘I

Creates an uptime check.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/uptime \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "TypeId": 1,
  "Target": {
    "Ip": "8.8.8.8",
    "Port": 443,
    "Url": "https://www.google.com"
  },
  "AdoptClientAssets": true,
  "ClientId": 123,
  "LocationId": 123,
  "Description": "<string>",
  "Frequency": 1,
  "NumberOfRetriesAfterFailure": 2,
  "RegionId": 1,
  "IspConnectionLink": "<string>",
  "TagIds": [
    123
  ]
}
'

import requests

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

payload = {
    "TypeId": 1,
    "Target": {
        "Ip": "8.8.8.8",
        "Port": 443,
        "Url": "https://www.google.com"
    },
    "AdoptClientAssets": True,
    "ClientId": 123,
    "LocationId": 123,
    "Description": "<string>",
    "Frequency": 1,
    "NumberOfRetriesAfterFailure": 2,
    "RegionId": 1,
    "IspConnectionLink": "<string>",
    "TagIds": [123]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+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-patch+json'},
  body: JSON.stringify({
    TypeId: 1,
    Target: {Ip: '8.8.8.8', Port: 443, Url: 'https://www.google.com'},
    AdoptClientAssets: true,
    ClientId: 123,
    LocationId: 123,
    Description: '<string>',
    Frequency: 1,
    NumberOfRetriesAfterFailure: 2,
    RegionId: 1,
    IspConnectionLink: '<string>',
    TagIds: [123]
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'TypeId' => 1,
    'Target' => [
        'Ip' => '8.8.8.8',
        'Port' => 443,
        'Url' => 'https://www.google.com'
    ],
    'AdoptClientAssets' => true,
    'ClientId' => 123,
    'LocationId' => 123,
    'Description' => '<string>',
    'Frequency' => 1,
    'NumberOfRetriesAfterFailure' => 2,
    'RegionId' => 1,
    'IspConnectionLink' => '<string>',
    'TagIds' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+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://api.usw.gorelo.io/v1/uptime"

	payload := strings.NewReader("{\n  \"TypeId\": 1,\n  \"Target\": {\n    \"Ip\": \"8.8.8.8\",\n    \"Port\": 443,\n    \"Url\": \"https://www.google.com\"\n  },\n  \"AdoptClientAssets\": true,\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"Description\": \"<string>\",\n  \"Frequency\": 1,\n  \"NumberOfRetriesAfterFailure\": 2,\n  \"RegionId\": 1,\n  \"IspConnectionLink\": \"<string>\",\n  \"TagIds\": [\n    123\n  ]\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+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://api.usw.gorelo.io/v1/uptime")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"TypeId\": 1,\n  \"Target\": {\n    \"Ip\": \"8.8.8.8\",\n    \"Port\": 443,\n    \"Url\": \"https://www.google.com\"\n  },\n  \"AdoptClientAssets\": true,\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"Description\": \"<string>\",\n  \"Frequency\": 1,\n  \"NumberOfRetriesAfterFailure\": 2,\n  \"RegionId\": 1,\n  \"IspConnectionLink\": \"<string>\",\n  \"TagIds\": [\n    123\n  ]\n}")
  .asString();

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::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"TypeId\": 1,\n  \"Target\": {\n    \"Ip\": \"8.8.8.8\",\n    \"Port\": 443,\n    \"Url\": \"https://www.google.com\"\n  },\n  \"AdoptClientAssets\": true,\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"Description\": \"<string>\",\n  \"Frequency\": 1,\n  \"NumberOfRetriesAfterFailure\": 2,\n  \"RegionId\": 1,\n  \"IspConnectionLink\": \"<string>\",\n  \"TagIds\": [\n    123\n  ]\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "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>"
    }
  ]
}