Skip to main content
POST
/
api
/
domains
Create a new domain
curl --request POST \
  --url https://api.ipulse.one/api/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com"
}
'
{
  "id": "domain_123",
  "url": "https://example.com",
  "name": "My Website",
  "status": "active",
  "check_interval": 300,
  "last_check": "2023-11-07T05:31:56Z",
  "uptime_percentage": 50,
  "response_time_ms": 123,
  "ssl_expires_at": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication

Body

application/json
​
url
string<uri>
required
Example:

"https://example.com"

​
name
string
Example:

"My Website"

​
check_interval
integer
default:300
Required range: 60 <= x <= 86400
Example:

300

​
timeout
integer
default:30
Required range: 5 <= x <= 300
Example:

30

​
expected_status_codes
integer[]
Example:
[200, 201, 301, 302]
​
follow_redirects
boolean
default:true
​
ssl_check
object
​
dns_check
object
​
tags
string[]
Example:
["production", "website"]

Response

Domain created successfully

​
id
string
Example:

"domain_123"

​
url
string<uri>
Example:

"https://example.com"

​
name
string
Example:

"My Website"

​
status
enum<string>
Available options:
active,
inactive,
pending
Example:

"active"

​
check_interval
integer
Example:

300

​
last_check
string<date-time> | null
​
uptime_percentage
number | null
Required range: 0 <= x <= 100
​
response_time_ms
integer | null
​
ssl_expires_at
string<date-time> | null
​
tags
string[]
​
created_at
string<date-time>
​
updated_at
string<date-time>