Check if a Domain is available to register

POST /v2/domain-registrable/

API version

v2

Request method

POST

Operation ID

domain-check-domain-registrability

---

If false, you have to start a transfer with an auth code instead.

Request

Responses

Format

application/json

Description

OK

Schema documentation

• isPremiumboolean

  required
• registrableboolean

  required

Example

{
  "isPremium": true,
  "registrable": true
}

JSON Schema

{
  "properties": {
    "isPremium": {
      "type": "boolean"
    },
    "registrable": {
      "type": "boolean"
    }
  },
  "required": [
    "registrable",
    "isPremium"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/domain-registrable

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.domain.checkDomainRegistrability({});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Domain\CheckDomainRegistrability\CheckDomainRegistrabilityRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Domain\CheckDomainRegistrability\CheckDomainRegistrabilityRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// CheckDomainRegistrabilityRequestBody to learn how to construct a valid instance
$body = new CheckDomainRegistrabilityRequestBody(/* TODO: ... */);

$request = (new CheckDomainRegistrabilityRequest(
  body: $body
));
$response = $client->domain()->checkDomainRegistrability($request);

var_dump($response->getBody();