HostAlert

Host alerts management

Get alerts defined for the given host

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostIdintegerRequired

ID of the host to fetch alert for

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Host alert ID

percentageinteger · integerRequired

At what percentage of bandwidth usage to trigger the alert

sendMailinteger · integerRequired

Will send an email notification when alert is triggered

sendTicketinteger · integerRequired

WIll create a ticket notification when alert is triggered

triggeredinteger · integerRead-onlyRequired

UNIX timestamp of the last time the alert was triggered

createdAtinteger · integerRead-onlyRequired

UNIX timestamp of the time the alert was created

403

Invalid credentials

404

Invalid host ID

500

Internal Server Error

application/json

get

/v3/host/{hostId}/alert

HTTPcURLJavaScriptPython

GET /v3/host/{hostId}/alert HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "percentage": 1,
    "sendMail": 1,
    "sendTicket": 1,
    "triggered": 1,
    "createdAt": 1
  }
]

Create alert for the host

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostIdintegerRequired

ID of the host to create an alert for

Body

application/json

idinteger · integerRead-onlyRequired

Host alert ID

percentageinteger · integerRequired

At what percentage of bandwidth usage to trigger the alert

sendMailinteger · integerRequired

Will send an email notification when alert is triggered

sendTicketinteger · integerRequired

WIll create a ticket notification when alert is triggered

triggeredinteger · integerRead-onlyRequired

UNIX timestamp of the last time the alert was triggered

createdAtinteger · integerRead-onlyRequired

UNIX timestamp of the time the alert was created

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Host alert ID

percentageinteger · integerRequired

At what percentage of bandwidth usage to trigger the alert

sendMailinteger · integerRequired

Will send an email notification when alert is triggered

sendTicketinteger · integerRequired

WIll create a ticket notification when alert is triggered

triggeredinteger · integerRead-onlyRequired

UNIX timestamp of the last time the alert was triggered

createdAtinteger · integerRead-onlyRequired

UNIX timestamp of the time the alert was created

403

Invalid credentials

404

Invalid host ID

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/host/{hostId}/alert

HTTPcURLJavaScriptPython

POST /v3/host/{hostId}/alert HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "percentage": 1,
  "sendMail": 1,
  "sendTicket": 1
}

[
  {
    "id": 1,
    "percentage": 1,
    "sendMail": 1,
    "sendTicket": 1,
    "triggered": 1,
    "createdAt": 1
  }
]

Update host alert

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostIdintegerRequired

ID of the host that the alert belongs to

hostAlertIdintegerRequired

ID of the host alert to update

Body

application/json

idinteger · integerRead-onlyRequired

Host alert ID

percentageinteger · integerRequired

At what percentage of bandwidth usage to trigger the alert

sendMailinteger · integerRequired

Will send an email notification when alert is triggered

sendTicketinteger · integerRequired

WIll create a ticket notification when alert is triggered

triggeredinteger · integerRead-onlyRequired

UNIX timestamp of the last time the alert was triggered

createdAtinteger · integerRead-onlyRequired

UNIX timestamp of the time the alert was created

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Host alert ID

percentageinteger · integerRequired

At what percentage of bandwidth usage to trigger the alert

sendMailinteger · integerRequired

Will send an email notification when alert is triggered

sendTicketinteger · integerRequired

WIll create a ticket notification when alert is triggered

triggeredinteger · integerRead-onlyRequired

UNIX timestamp of the last time the alert was triggered

createdAtinteger · integerRead-onlyRequired

UNIX timestamp of the time the alert was created

403

Invalid credentials

404

Invalid host ID or alert ID

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/host/{hostId}/alert/{hostAlertId}

HTTPcURLJavaScriptPython

PUT /v3/host/{hostId}/alert/{hostAlertId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "percentage": 1,
  "sendMail": 1,
  "sendTicket": 1
}

[
  {
    "id": 1,
    "percentage": 1,
    "sendMail": 1,
    "sendTicket": 1,
    "triggered": 1,
    "createdAt": 1
  }
]

Delete host alert

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostIdintegerRequired

ID of the host that the alert belongs to

hostAlertIdintegerRequired

ID of the alert to delete

Responses

204

No Content

403

Invalid credentials

404

Invalid host ID or alert ID

500

Internal Server Error

application/json

delete

/v3/host/{hostId}/alert/{hostAlertId}

HTTPcURLJavaScriptPython

DELETE /v3/host/{hostId}/alert/{hostAlertId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Set RDNS hostname for IP

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostIdintegerRequired

ID of the host to which IP address belongs to

ipAddressstringRequired

IP address to set RDNS entry for

Body

application/json

hostnamestringRequired

The hostname

ipstringRead-onlyRequired

The corresponding ip for the host

Responses

204

No Content

403

Invalid credentials

404

Invalid host ID or IP address

500

Internal Server Error

application/json

put

/v3/host/{hostId}/network/rdns/{ipAddress}

HTTPcURLJavaScriptPython

PUT /v3/host/{hostId}/network/rdns/{ipAddress} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "hostname": "text"
}

No content