Assets

Updates an uptime check. Send only the fields you want to change.

An omitted field is left alone, and re-sending a value the check already holds is a no-op rather than an error. Sending nothing at all is a 400.

TagIds replaces the check’s tags outright; an empty array clears them. Changing TypeId requires a Target for the new type, because the two are stored together and the old target would not fit.

MaintenanceMode starts or ends a maintenance window for this check. Omit it to leave the current state alone; send Enabled: true with a start, a duration and a reason to begin one, or Enabled: false on its own to end it. A duration of zero means the window does not expire on its own.

PATCH

uptime

{uptimeId}

Updates an uptime check. Send only the fields you want to change.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/uptime/{uptimeId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "TypeId": 123,
  "Target": {
    "Ip": "8.8.8.8",
    "Port": 443,
    "Url": "https://www.google.com"
  },
  "AdoptClientAssets": true,
  "ClientId": 123,
  "LocationId": 123,
  "Description": "<string>",
  "Frequency": 123,
  "NumberOfRetriesAfterFailure": 123,
  "RegionId": 123,
  "IspConnectionLink": "<string>",
  "TagIds": [
    123
  ],
  "MaintenanceMode": {
    "Enabled": true,
    "StartDateTime": "2023-11-07T05:31:56Z",
    "DurationInMinutes": 123,
    "Reason": "<string>"
  }
}
'

import requests

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

payload = {
    "TypeId": 123,
    "Target": {
        "Ip": "8.8.8.8",
        "Port": 443,
        "Url": "https://www.google.com"
    },
    "AdoptClientAssets": True,
    "ClientId": 123,
    "LocationId": 123,
    "Description": "<string>",
    "Frequency": 123,
    "NumberOfRetriesAfterFailure": 123,
    "RegionId": 123,
    "IspConnectionLink": "<string>",
    "TagIds": [123],
    "MaintenanceMode": {
        "Enabled": True,
        "StartDateTime": "2023-11-07T05:31:56Z",
        "DurationInMinutes": 123,
        "Reason": "<string>"
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    TypeId: 123,
    Target: {Ip: '8.8.8.8', Port: 443, Url: 'https://www.google.com'},
    AdoptClientAssets: true,
    ClientId: 123,
    LocationId: 123,
    Description: '<string>',
    Frequency: 123,
    NumberOfRetriesAfterFailure: 123,
    RegionId: 123,
    IspConnectionLink: '<string>',
    TagIds: [123],
    MaintenanceMode: {
      Enabled: true,
      StartDateTime: '2023-11-07T05:31:56Z',
      DurationInMinutes: 123,
      Reason: '<string>'
    }
  })
};

fetch('https://api.usw.gorelo.io/v1/uptime/{uptimeId}', 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/{uptimeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'TypeId' => 123,
    'Target' => [
        'Ip' => '8.8.8.8',
        'Port' => 443,
        'Url' => 'https://www.google.com'
    ],
    'AdoptClientAssets' => true,
    'ClientId' => 123,
    'LocationId' => 123,
    'Description' => '<string>',
    'Frequency' => 123,
    'NumberOfRetriesAfterFailure' => 123,
    'RegionId' => 123,
    'IspConnectionLink' => '<string>',
    'TagIds' => [
        123
    ],
    'MaintenanceMode' => [
        'Enabled' => true,
        'StartDateTime' => '2023-11-07T05:31:56Z',
        'DurationInMinutes' => 123,
        'Reason' => '<string>'
    ]
  ]),
  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/{uptimeId}"

	payload := strings.NewReader("{\n  \"TypeId\": 123,\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\": 123,\n  \"NumberOfRetriesAfterFailure\": 123,\n  \"RegionId\": 123,\n  \"IspConnectionLink\": \"<string>\",\n  \"TagIds\": [\n    123\n  ],\n  \"MaintenanceMode\": {\n    \"Enabled\": true,\n    \"StartDateTime\": \"2023-11-07T05:31:56Z\",\n    \"DurationInMinutes\": 123,\n    \"Reason\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.usw.gorelo.io/v1/uptime/{uptimeId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"TypeId\": 123,\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\": 123,\n  \"NumberOfRetriesAfterFailure\": 123,\n  \"RegionId\": 123,\n  \"IspConnectionLink\": \"<string>\",\n  \"TagIds\": [\n    123\n  ],\n  \"MaintenanceMode\": {\n    \"Enabled\": true,\n    \"StartDateTime\": \"2023-11-07T05:31:56Z\",\n    \"DurationInMinutes\": 123,\n    \"Reason\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/uptime/{uptimeId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"TypeId\": 123,\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\": 123,\n  \"NumberOfRetriesAfterFailure\": 123,\n  \"RegionId\": 123,\n  \"IspConnectionLink\": \"<string>\",\n  \"TagIds\": [\n    123\n  ],\n  \"MaintenanceMode\": {\n    \"Enabled\": true,\n    \"StartDateTime\": \"2023-11-07T05:31:56Z\",\n    \"DurationInMinutes\": 123,\n    \"Reason\": \"<string>\"\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>"
    }
  ]
}

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

Autoritzacions

X-API-Key

string

header

requerit

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.

Paràmetres de ruta

uptimeId

string<uuid>

requerit

Uptime to update.

Cos

Fields to change.

Request body for updating an uptime check. Every field is optional - send only what should change. An omitted field keeps the value the check already holds.

TypeId

integer<int32> | null

What the check does: 1 ICMP, 2 HTTP, 3 TCP. Changing this requires sending a Target valid for the new type, because the two are stored together.

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 | null

Move matching unassigned devices to the check's client. See the create request.

ClientId

integer<int64> | null

Identifier of the client the check belongs to. Sending this without LocationId is rejected, because a location belongs to a client and moving one without the other would file the check at the old client's site.

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> | null

How often the check runs, in minutes.

NumberOfRetriesAfterFailure

integer<int32> | null

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

RegionId

integer<int32> | null

Which monitoring region runs the check. Changing it cancels the check's schedule in the old region and schedules it in the new one.

IspConnectionLink

string | null

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

TagIds

integer<int64>[] | null

Replaces the check's tags outright. An empty array clears them; omitting the field leaves them alone.

MaintenanceMode

object

A check's maintenance window - the period its failures are suppressed for.

Field names match the ones the update request takes.

Show child attributes

Resposta

StatusCode

enum<integer>

Opcions 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 updated uptime check.

Show child attributes

DataContext

object | null

Exemple:

null

Notifications

object[]

Show child attributes

⌘I

Updates an uptime check. Send only the fields you want to change.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/uptime/{uptimeId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "TypeId": 123,
  "Target": {
    "Ip": "8.8.8.8",
    "Port": 443,
    "Url": "https://www.google.com"
  },
  "AdoptClientAssets": true,
  "ClientId": 123,
  "LocationId": 123,
  "Description": "<string>",
  "Frequency": 123,
  "NumberOfRetriesAfterFailure": 123,
  "RegionId": 123,
  "IspConnectionLink": "<string>",
  "TagIds": [
    123
  ],
  "MaintenanceMode": {
    "Enabled": true,
    "StartDateTime": "2023-11-07T05:31:56Z",
    "DurationInMinutes": 123,
    "Reason": "<string>"
  }
}
'

import requests

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

payload = {
    "TypeId": 123,
    "Target": {
        "Ip": "8.8.8.8",
        "Port": 443,
        "Url": "https://www.google.com"
    },
    "AdoptClientAssets": True,
    "ClientId": 123,
    "LocationId": 123,
    "Description": "<string>",
    "Frequency": 123,
    "NumberOfRetriesAfterFailure": 123,
    "RegionId": 123,
    "IspConnectionLink": "<string>",
    "TagIds": [123],
    "MaintenanceMode": {
        "Enabled": True,
        "StartDateTime": "2023-11-07T05:31:56Z",
        "DurationInMinutes": 123,
        "Reason": "<string>"
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    TypeId: 123,
    Target: {Ip: '8.8.8.8', Port: 443, Url: 'https://www.google.com'},
    AdoptClientAssets: true,
    ClientId: 123,
    LocationId: 123,
    Description: '<string>',
    Frequency: 123,
    NumberOfRetriesAfterFailure: 123,
    RegionId: 123,
    IspConnectionLink: '<string>',
    TagIds: [123],
    MaintenanceMode: {
      Enabled: true,
      StartDateTime: '2023-11-07T05:31:56Z',
      DurationInMinutes: 123,
      Reason: '<string>'
    }
  })
};

fetch('https://api.usw.gorelo.io/v1/uptime/{uptimeId}', 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/{uptimeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'TypeId' => 123,
    'Target' => [
        'Ip' => '8.8.8.8',
        'Port' => 443,
        'Url' => 'https://www.google.com'
    ],
    'AdoptClientAssets' => true,
    'ClientId' => 123,
    'LocationId' => 123,
    'Description' => '<string>',
    'Frequency' => 123,
    'NumberOfRetriesAfterFailure' => 123,
    'RegionId' => 123,
    'IspConnectionLink' => '<string>',
    'TagIds' => [
        123
    ],
    'MaintenanceMode' => [
        'Enabled' => true,
        'StartDateTime' => '2023-11-07T05:31:56Z',
        'DurationInMinutes' => 123,
        'Reason' => '<string>'
    ]
  ]),
  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/{uptimeId}"

	payload := strings.NewReader("{\n  \"TypeId\": 123,\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\": 123,\n  \"NumberOfRetriesAfterFailure\": 123,\n  \"RegionId\": 123,\n  \"IspConnectionLink\": \"<string>\",\n  \"TagIds\": [\n    123\n  ],\n  \"MaintenanceMode\": {\n    \"Enabled\": true,\n    \"StartDateTime\": \"2023-11-07T05:31:56Z\",\n    \"DurationInMinutes\": 123,\n    \"Reason\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.usw.gorelo.io/v1/uptime/{uptimeId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"TypeId\": 123,\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\": 123,\n  \"NumberOfRetriesAfterFailure\": 123,\n  \"RegionId\": 123,\n  \"IspConnectionLink\": \"<string>\",\n  \"TagIds\": [\n    123\n  ],\n  \"MaintenanceMode\": {\n    \"Enabled\": true,\n    \"StartDateTime\": \"2023-11-07T05:31:56Z\",\n    \"DurationInMinutes\": 123,\n    \"Reason\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/uptime/{uptimeId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"TypeId\": 123,\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\": 123,\n  \"NumberOfRetriesAfterFailure\": 123,\n  \"RegionId\": 123,\n  \"IspConnectionLink\": \"<string>\",\n  \"TagIds\": [\n    123\n  ],\n  \"MaintenanceMode\": {\n    \"Enabled\": true,\n    \"StartDateTime\": \"2023-11-07T05:31:56Z\",\n    \"DurationInMinutes\": 123,\n    \"Reason\": \"<string>\"\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>"
    }
  ]
}

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