Check if a Domain is available to transfer

POST /v2/domain-transferable/

API version

v2

Request method

POST

Operation ID

domain-check-domain-transferability

---

Request

Responses

Format

application/json

Description

OK

Schema documentation

• reasonsobject

  required
  • domainAgeTooSmallboolean

    required
  • domainDoesNotExistboolean

    required
  • transferLockboolean

    required
  • wrongAuthCodeboolean

    required
• transferableboolean

  required

Example

{
  "reasons": {
    "domainAgeTooSmall": true,
    "domainDoesNotExist": true,
    "transferLock": true,
    "wrongAuthCode": true
  },
  "transferable": true
}

JSON Schema

{
  "properties": {
    "reasons": {
      "properties": {
        "domainAgeTooSmall": {
          "type": "boolean"
        },
        "domainDoesNotExist": {
          "type": "boolean"
        },
        "transferLock": {
          "type": "boolean"
        },
        "wrongAuthCode": {
          "type": "boolean"
        }
      },
      "required": [
        "domainDoesNotExist",
        "wrongAuthCode",
        "transferLock",
        "domainAgeTooSmall"
      ],
      "type": "object"
    },
    "transferable": {
      "type": "boolean"
    }
  },
  "required": [
    "transferable",
    "reasons"
  ],
  "type": "object"
}

Usage examples

cURL

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

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.checkDomainTransferability({});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Domain\CheckDomainTransferability\CheckDomainTransferabilityRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Domain\CheckDomainTransferability\CheckDomainTransferabilityRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new CheckDomainTransferabilityRequest(
  body: $body
));
$response = $client->domain()->checkDomainTransferability($request);

var_dump($response->getBody();