Domains
Registering new domains and transferring existing ones.
- GET
/domains/optionsDomain prices - GET
/domains/checkIs a domain free? - GET
/domains/requestsList domain requests - POST
/domains/requestsAsk for a domain - GET
/domains/requests/{request_id}A domain request - DELETE
/domains/requests/{request_id}Cancel a domain request - POST
/domains/requests/{request_id}/verifyCheck the domain's records - POST
/domains/requests/{request_id}/ask-approvalSend the approval email again
Domain prices
GET/domains/options
Needs the permission website:manage
The extensions that can be registered, and their prices.
Response 200
email_domainsrequired | integer | null | |
websitesrequired | integer | null | |
dns_zonesrequired | integer | null | |
web_serversrequired | object[] | |
idrequired | string | |
hostnamerequired | string |
curl "https://portal.nimag.net/api/v1/domains/options" \ -H "Authorization: Bearer nck_…"
{
"email_domains": 0,
"websites": 0,
"dns_zones": 0,
"web_servers": [
{
"id": "string",
"hostname": "string"
}
]
}Is a domain free?
GET/domains/check
Needs the permission ticket:manage
Whether a domain can be registered now.
Query
domainrequired | string |
Response 200
domainrequired | string | |
availablerequired | boolean | |
need_transferrequired | boolean | |
premiumrequired | boolean | |
managedrequired | boolean |
curl "https://portal.nimag.net/api/v1/domains/check?domain=…" \ -H "Authorization: Bearer nck_…"
{
"domain": "string",
"available": true,
"need_transfer": true,
"premium": true,
"managed": true
}List domain requests
GET/domains/requests
Needs the permission website:read
Registrations and transfers asked for, and where each stands.
Response 200
idrequired | string (uuid) | |
domainrequired | string | |
mailrequired | boolean | |
webrequired | boolean | |
dnsrequired | boolean | |
statusrequired | string | |
verify_namerequired | string | |
verify_valuerequired | string | |
noterequired | string | |
errorrequired | string | |
created_atrequired | string (date-time) |
curl "https://portal.nimag.net/api/v1/domains/requests" \ -H "Authorization: Bearer nck_…"
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"domain": "string",
"mail": true,
"web": true,
"dns": true,
"status": "string",
"verify_name": "string",
"verify_value": "string",
"note": "string",
"error": "string",
"created_at": "2026-01-31T12:00:00Z"
}
]Ask for a domain
POST/domains/requests
Needs the permission website:manage
A registration, or a transfer from another registrar.
Body (JSON)
domainrequired | string | up to 253 characters |
mail | boolean | default false |
web | boolean | default false |
dns | boolean | default false |
web_server_id | string | null | up to 16 characters |
Response 201
idrequired | string (uuid) | |
domainrequired | string | |
mailrequired | boolean | |
webrequired | boolean | |
dnsrequired | boolean | |
statusrequired | string | |
verify_namerequired | string | |
verify_valuerequired | string | |
noterequired | string | |
errorrequired | string | |
created_atrequired | string (date-time) |
curl -X POST "https://portal.nimag.net/api/v1/domains/requests" \
-H "Authorization: Bearer nck_…" \
-H "Content-Type: application/json" \
-d '{
"domain": "string",
"mail": false,
"web": false,
"dns": false,
"web_server_id": "string"
}'{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"domain": "string",
"mail": true,
"web": true,
"dns": true,
"status": "string",
"verify_name": "string",
"verify_value": "string",
"note": "string",
"error": "string",
"created_at": "2026-01-31T12:00:00Z"
}A domain request
GET/domains/requests/{request_id}
Needs the permission website:read
Path
request_idrequired | string (uuid) |
Response 200
idrequired | string (uuid) | |
domainrequired | string | |
mailrequired | boolean | |
webrequired | boolean | |
dnsrequired | boolean | |
statusrequired | string | |
verify_namerequired | string | |
verify_valuerequired | string | |
noterequired | string | |
errorrequired | string | |
created_atrequired | string (date-time) |
curl "https://portal.nimag.net/api/v1/domains/requests/{request_id}" \
-H "Authorization: Bearer nck_…"{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"domain": "string",
"mail": true,
"web": true,
"dns": true,
"status": "string",
"verify_name": "string",
"verify_value": "string",
"note": "string",
"error": "string",
"created_at": "2026-01-31T12:00:00Z"
}Cancel a domain request
DELETE/domains/requests/{request_id}
Needs the permission website:manage
Only before Nimag has acted on it.
Path
request_idrequired | string (uuid) |
Response 200
idrequired | string (uuid) | |
domainrequired | string | |
mailrequired | boolean | |
webrequired | boolean | |
dnsrequired | boolean | |
statusrequired | string | |
verify_namerequired | string | |
verify_valuerequired | string | |
noterequired | string | |
errorrequired | string | |
created_atrequired | string (date-time) |
curl -X DELETE "https://portal.nimag.net/api/v1/domains/requests/{request_id}" \
-H "Authorization: Bearer nck_…"{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"domain": "string",
"mail": true,
"web": true,
"dns": true,
"status": "string",
"verify_name": "string",
"verify_value": "string",
"note": "string",
"error": "string",
"created_at": "2026-01-31T12:00:00Z"
}Check the domain's records
POST/domains/requests/{request_id}/verify
Needs the permission website:manage
For a transfer: whether the records the request asked for are in place.
Path
request_idrequired | string (uuid) |
Response 200
idrequired | string (uuid) | |
domainrequired | string | |
mailrequired | boolean | |
webrequired | boolean | |
dnsrequired | boolean | |
statusrequired | string | |
verify_namerequired | string | |
verify_valuerequired | string | |
noterequired | string | |
errorrequired | string | |
created_atrequired | string (date-time) |
curl -X POST "https://portal.nimag.net/api/v1/domains/requests/{request_id}/verify" \
-H "Authorization: Bearer nck_…"{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"domain": "string",
"mail": true,
"web": true,
"dns": true,
"status": "string",
"verify_name": "string",
"verify_value": "string",
"note": "string",
"error": "string",
"created_at": "2026-01-31T12:00:00Z"
}Send the approval email again
POST/domains/requests/{request_id}/ask-approval
Needs the permission website:manage
Path
request_idrequired | string (uuid) |
Response 200
idrequired | string (uuid) | |
domainrequired | string | |
mailrequired | boolean | |
webrequired | boolean | |
dnsrequired | boolean | |
statusrequired | string | |
verify_namerequired | string | |
verify_valuerequired | string | |
noterequired | string | |
errorrequired | string | |
created_atrequired | string (date-time) |
curl -X POST "https://portal.nimag.net/api/v1/domains/requests/{request_id}/ask-approval" \
-H "Authorization: Bearer nck_…"{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"domain": "string",
"mail": true,
"web": true,
"dns": true,
"status": "string",
"verify_name": "string",
"verify_value": "string",
"note": "string",
"error": "string",
"created_at": "2026-01-31T12:00:00Z"
}