Date: Thu, 28 Mar 2024 12:33:08 +0000 (UTC) Message-ID: <2063821811.5359.1711629188090@ip-10-0-1-161.ec2.internal> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_5358_524579164.1711629188086" ------=_Part_5358_524579164.1711629188086 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Access all API commands using the following general format:
https:/= /<hostname>:<port>/api/<api_version>/<end_point>/&l= t;id>/<task>
hostname
: the URI for the Uptime Infrastructure Monitor Co=
ntroller installationport
: the Uptime Infrastructure Monitor Controller listene=
r port, typically 9997api_version
: the version of the API to run commands agains=
t (see Version Control below)=
li>
end_point
: the type of object you want to work with in Upt=
ime Infrastructure Monitor (see Endpoint=
s below)id
: the numerical ID of the object you are interested in=
li>
task
: where supported, specific tasks to be executed again=
st the provided objectAccessing the standard format URL using different HTTP methods produces = different results on the target object:
POST
: add an object or trigger an actionPUT
: edit an objectDELETE
: delete an objectGET
: view the details of an objectAll returned results are provided in JSON format. Successfully completed= requests return an HTTP code in the 200 range.
Authentication to the API is based on the basic HTTP basic authenticatio= n template: each request to the API must provide a username and password pa= ir. To safeguard this information, all requests to the Uptime Infrastructur= e Monitor API must use SSL communication.
Each user in Uptime Infrastructure Monitor has access to the API. User-v= isibility and role-based permissions are applied to each API call, ensuring= users are only able to access and modify the same information they would b= e able to access from the Uptime Infrastructure Monitor UI.
The version of the API you wish to access is embedded directly into the = URL. Bug fixes and non-breaking feature changes are made without changing t= he version number. Major feature changes or breaking changes introduce a ne= w version number. Backward support for previous API version is currently no= t defined.
Non-breaking changes include:
Breaking changes include:
Endpoints define the different types of Uptime Infrastructure Monitor ob= jects that you can work with using the API. The currently supported endpoin= ts include the following:
/elements
=E2=80=93 Uptime Infrastructure Monitor Elements<=
br>/monitors
=E2=80=93 Uptime Infrastructure Monitor serv=
ice monitors/groups
=E2=80=93 Uptime Infrastructure Monito=
r Element groups
The following is a summary of presently available resources:
list all Elements and attached service mo= nitors; display an Element's information and attached service monitors; dis= play an Element's information and its current status:
GET
GET
GET
/api/v1/elements
/api/v1/elements
=
code>/{id}
/status
/{i=
d}/api/v1/elements
update Element configuration:
PUT
/api/v1
/elements
/{id}
add, delete Element:
POST
DELETE
/api/v1/elements
=
/api/v1/elements/{id}
list all service monitors; display a spec= ific server monitor; display status information for a service monitor:
GET
GET
GET
/api/v1/monitors
/api/v1/monitors
=
code>/{id}
/status
/{i=
d}/api/v1/monitors
list all Element groups, member Elements,= and monitors; list an Element group's member Elements and monitors; displa= y the status of an Element group's member Elements and monitors:
GET
GET
GET
/api/v1/groups
/{id}/api/v1/groups
/status
/{id} /api/v1/groups
If the provided command produces an error, an HTTP status in the 400 ran= ge is returned including a specific status code and a message with further = details about the error. All error messages are returned in JSON format and= look like the following:
{
&=
nbsp; "error" : "Required field missi=
ng" ,
&=
nbsp; "errorDescription" null
}
|