API Documentation
API access available for plans:
- Business
- Enterprise
Authentication
To use the API, you must:
- Get an access token from your account
- Include the token in your request headers:
Authorization: Bearer {token}
List Domains
GET /api/v1/domains
Retrieves a paginated list of domains for the authenticated user.
Headers
| Name | Value | Description |
|---|---|---|
| Authorization | Bearer {token} | Authentication token to access the API |
| Accept | application/json | Expected response format |
Response
{
"data": [
{
"id": 1,
"domain": "example.com",
"valid": true,
"type": "EV",
"ssl_expires_at": "2024-12-31T23:59:59.000000Z",
"last_check_at": "2024-03-21T10:00:00.000000Z",
"created_at": "2024-03-21T10:00:00.000000Z",
"updated_at": "2024-03-21T10:00:00.000000Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}
Create Domain
POST /api/v1/domains
Creates a new domain for the authenticated user.
Parameters
| Name | Type | Description |
|---|---|---|
| Domain | String | Domain URL (max: 255 characters) |
Request Example
{
"domain": "example.com"
}
Response
{
"data": {
"id": 1,
"domain": "example.com",
"valid": false,
"type": null,
"ssl_expires_at": null,
"last_check_at": null,
"created_at": "2024-03-21T10:00:00.000000Z",
"updated_at": "2024-03-21T10:00:00.000000Z"
}
}
Get Domain Details
GET /api/v1/domains/{id}
Retrieves details of a specific domain.
Parameters
| Name | Type | Description |
|---|---|---|
| ID | Integer | Unique domain identifier |
Response
{
"data": {
"id": 1,
"domain": "example.com",
"valid": true,
"type": "EV",
"ssl_expires_at": "2024-12-31T23:59:59.000000Z",
"last_check_at": "2024-03-21T10:00:00.000000Z",
"created_at": "2024-03-21T10:00:00.000000Z",
"updated_at": "2024-03-21T10:00:00.000000Z"
}
}
Update Domain
PUT /api/v1/domains/{id}
Updates an existing domain.
Parameters
| Name | Type | Description |
|---|---|---|
| ID | Integer | Unique domain identifier |
| Domain | String | Domain URL (max: 255 characters) |
Request Example
{
"domain": "example.com"
}
Response
{
"data": {
"id": 1,
"domain": "example.com",
"valid": true,
"type": "EV",
"ssl_expires_at": "2024-12-31T23:59:59.000000Z",
"last_check_at": "2024-03-21T10:00:00.000000Z",
"created_at": "2024-03-21T10:00:00.000000Z",
"updated_at": "2024-03-21T10:30:00.000000Z"
}
}
Delete Domain
DELETE /api/v1/domains/{id}
Deletes an existing domain.
Parameters
| Name | Type | Description |
|---|---|---|
| ID | Integer | Unique domain identifier |
Response
Status code: 204 (No Content)
Error Codes
| id | Domain ID |
|---|---|
| 401 | Unauthenticated |
| 403 | Unauthorized access (incompatible plan) |
| 404 | Domain not found |
| 422 | Validation error |