Check domain availability

Request Information
URL POST {{basepath}}/domain/check
CategoryREPP Domain

Description

Allows you to Check if a domain is available for registration and if the domain is premium or not.

Expects a DomainCheckRequest object.

Returns a DomainCheckResponse object.

JSON
{
    "name": [
        "zerg-test-controlpanel-2023-06-09-08.frl",
        "german.school"
    ]
}

Example responses

Check domain availability
Request Method & URL
POST {{basepath}}/domain/check
Request Body:
{
    "name": [
        "zerg-test-controlpanel-2023-06-09-08.frl",
        "german.school"
    ]
}
Response Code:
200 OK
Response Body:
{
    "responseId": "mapi1_b2900fdd441382cd62fc28555f5c4c0b0a11c5ad",
    "status": "ok",
    "message": "Command completed successfully",
    "results": [
        {
            "name": "zerg-test-controlpanel-2023-06-09-08.frl",
            "available": true,
            "reason": "Domain is available for registration",
            "premium": false
        },
        {
            "name": "german.school",
            "available": false,
            "reason": "Domain is not available for registration",
            "premium": true,
            "premiumPrice": 22000,
            "premiumRecurringPrice": 0,
            "premiumPriceMessage": "This is only the premium price. The normal registration costs still applies."
        }
    ]
}