Get a HandleSchema

GET/domains/handle-schema/{domainName}/

warning

This operation is deprecated and should not be used anymore. Please refer to this operation's description for alternatives.

API version

v2

Request method

GET

Operation ID

domain-get-handle-fields-v2-deprecated

---

Get required handle fields of a registrar for your domain process (transfer/registration).

Request

• domainNamestring (naked-domain)

  required

  The whole domain name

Responses

Format

application/json

Description

The parseable json schema objects

Schema documentation

• jsonSchemaAdminCobject
• jsonSchemaOwnerCobject

  required

Example

{
  "jsonSchemaAdminC": {},
  "jsonSchemaOwnerC": {}
}

JSON Schema

{
  "properties": {
    "jsonSchemaAdminC": {
      "type": "object"
    },
    "jsonSchemaOwnerC": {
      "type": "object"
    }
  },
  "required": [
    "jsonSchemaOwnerC"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/domains/handle-schema/string

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.getHandleFieldsV2Deprecated({
  "domainName": "string"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetHandleFieldsV2DeprecatedRequest(
  domainName: "string"
));
$response = $client->domain()->getHandleFieldsV2Deprecated($request);

var_dump($response->getBody();