List TLDs

GET/domain-tlds/

API version

v2

Request method

GET

Operation ID

domain-list-tlds

---

List the top level domains currently supported by our API.

Request

No request parameters.

Responses

Format

application/json

Description

Schema documentation

• Array[
• *object
  • irtpboolean

    required
  • rgpDaysinteger (≥ 0)

    required
  • tldstring

    required
  • transferAuthCodeRequiredboolean

    required
  • transferAuthenticationstring (one of: unspecified, code, email, push)

    required
]

Example

[
  {
    "irtp": true,
    "rgpDays": 123,
    "tld": "string",
    "transferAuthCodeRequired": true,
    "transferAuthentication": "unspecified"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "irtp": {
        "type": "boolean"
      },
      "rgpDays": {
        "minimum": 0,
        "type": "integer"
      },
      "tld": {
        "type": "string"
      },
      "transferAuthCodeRequired": {
        "deprecated": true,
        "type": "boolean"
      },
      "transferAuthentication": {
        "enum": [
          "unspecified",
          "code",
          "email",
          "push"
        ],
        "type": "string"
      }
    },
    "required": [
      "tld",
      "rgpDays",
      "irtp",
      "transferAuthCodeRequired",
      "transferAuthentication"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

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

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

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ListTldsRequest());
$response = $client->domain()->listTlds($request);

var_dump($response->getBody();