API docs by Redocly

Hydrozen.io API (1.0.0)

Download OpenAPI specification:

The Hydrozen.io API allows developers to programmatically manage uptime, heartbeat, and domain monitors. It supports full CRUD operations, authentication via API key, and event reporting via webhooks.

Uptime Monitors

List all uptime monitors

Authorizations:
bearerAuth
query Parameters
page
integer
limit
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new uptime monitor

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string
url
string
type
string
frequency
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "url": "string",
  • "type": "string",
  • "frequency": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "http",
  • "url": "string",
  • "frequency": 0,
  • "last_status": "up",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an uptime monitor by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "http",
  • "url": "string",
  • "frequency": 0,
  • "last_status": "up",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update an uptime monitor

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
id
string
name
string
type
string
Enum: "http" "tcp" "udp" "ping"
url
string
frequency
integer

Frequency of checks in seconds

last_status
string
Enum: "up" "down" "unknown"
created_at
string <date-time>
updated_at
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "http",
  • "url": "string",
  • "frequency": 0,
  • "last_status": "up",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "http",
  • "url": "string",
  • "frequency": 0,
  • "last_status": "up",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete an uptime monitor

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Heartbeat Monitors

List all heartbeat monitors

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new heartbeat monitor

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string
expected_interval
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "expected_interval": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "slug": "string",
  • "expected_interval": 0,
  • "last_ping": "2019-08-24T14:15:22Z"
}

Retrieve a heartbeat monitor

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "slug": "string",
  • "expected_interval": 0,
  • "last_ping": "2019-08-24T14:15:22Z"
}

Delete a heartbeat monitor

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Domain Monitors

List domain monitors

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a domain monitor

Authorizations:
bearerAuth
Request Body schema: application/json
required
domain
string

Responses

Request samples

Content type
application/json
{
  • "domain": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "domain": "string",
  • "expires_on": "2019-08-24",
  • "days_until_expiry": 0,
  • "registrar": "string"
}

Retrieve domain monitor by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "domain": "string",
  • "expires_on": "2019-08-24",
  • "days_until_expiry": 0,
  • "registrar": "string"
}

Delete a domain monitor

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Notification Handlers

List notification handlers

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new notification handler

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string
type
string
destination
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "destination": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "email",
  • "destination": "string"
}

Retrieve notification handler

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "email",
  • "destination": "string"
}

Delete notification handler

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses