Get a Domain

GET/domains/{domainId}/

API version

v2

Request method

GET

Operation ID

domain-get-domain

---

Request

• domainIdstring

  required

Responses

Format

application/json

Beschreibung

OK

Schema-Dokumentation

• authCodeobject
  • expiresstring (date-time)
  • valuestring

    required
• authCode2object
  • expiresstring (date-time)

    required
• connectedboolean

  required
• contactHashstring
• deletedboolean

  required
• domainstring (naked-domain)

  required
• domainIdstring (uuid)

  required
• handlesobject

  required
  • adminCobject
    • currentobject

      required
      • handleFieldsarray of object
        • Array[
          • *object
            • namestring

              required
            • valuestring

              required
          ]
      • handleRefstring
    • desiredobject
      • handleFieldsarray of object
        • Array[
          • *object
            • namestring

              required
            • valuestring

              required
          ]
      • handleRefstring
  • ownerCobject

    required
    • currentobject

      required
      • handleFieldsarray of object
        • Array[
          • *object
            • namestring

              required
            • valuestring

              required
          ]
      • handleRefstring
    • desiredobject
      • handleFieldsarray of object
        • Array[
          • *object
            • namestring

              required
            • valuestring

              required
          ]
      • handleRefstring
• nameserversarray of string (idn-hostname)

  required
  • Array[
    • *string (idn-hostname)
    ]
• processesarray of object
  • Array[
    • *object
      • errorstring
      • lastUpdatestring (date-time)

        required
      • processTypestring (one of: UNSPECIFIED, REGISTER, TRANSFER, DELETE, TRANSIT, RESTORE, UPDATE, TRANSFER_OUT, OWNER_CHANGE, DECLARE_REQUESTED)

        required
      • statestring (one of: UNSPECIFIED, REQUESTED, FAILED)

        required
      • statusstring
      • statusCodestring
      • transactionIdstring

        required
    ]
• projectIdstring (uuid)

  required
• scheduledDeletionDatestring (date-time)
• transferInAuthCodestring
• usesDefaultNameserverboolean

  required

Beispiel

Content-Type: application/json

{
  "authCode": {
    "expires": "1985-10-26T01:21:00.000Z",
    "value": "string"
  },
  "authCode2": {
    "expires": "1985-10-26T01:21:00.000Z"
  },
  "connected": true,
  "contactHash": "string",
  "deleted": true,
  "domain": "string",
  "domainId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "handles": {
    "adminC": {
      "current": {
        "handleFields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "handleRef": "string"
      },
      "desired": {
        "handleFields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "handleRef": "string"
      }
    },
    "ownerC": {
      "current": {
        "handleFields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "handleRef": "string"
      },
      "desired": {
        "handleFields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "handleRef": "string"
      }
    }
  },
  "nameservers": [
    "some-hostname.example"
  ],
  "processes": [
    {
      "error": "string",
      "lastUpdate": "1985-10-26T01:21:00.000Z",
      "processType": "UNSPECIFIED",
      "state": "UNSPECIFIED",
      "status": "string",
      "statusCode": "string",
      "transactionId": "string"
    }
  ],
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "scheduledDeletionDate": "1985-10-26T01:21:00.000Z",
  "transferInAuthCode": "string",
  "usesDefaultNameserver": true
}

JSON Schema

{
  "properties": {
    "authCode": {
      "properties": {
        "expires": {
          "format": "date-time",
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "value"
      ],
      "type": "object"
    },
    "authCode2": {
      "properties": {
        "expires": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "expires"
      ],
      "type": "object"
    },
    "connected": {
      "type": "boolean"
    },
    "contactHash": {
      "type": "string"
    },
    "deleted": {
      "type": "boolean"
    },
    "domain": {
      "format": "naked-domain",
      "type": "string"
    },
    "domainId": {
      "format": "uuid",
      "type": "string"
    },
    "handles": {
      "properties": {
        "adminC": {
          "properties": {
            "current": {
              "properties": {
                "handleFields": {
                  "items": {
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "value": {
                        "pattern": "^[0-9a-zA-ZÀ-ÖØ-öø-ÿ /&()+,.@_-]+$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "name",
                      "value"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "handleRef": {
                  "type": "string"
                }
              },
              "type": "object"
            },
            "desired": {
              "properties": {
                "handleFields": {
                  "items": {
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "value": {
                        "pattern": "^[0-9a-zA-ZÀ-ÖØ-öø-ÿ /&()+,.@_-]+$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "name",
                      "value"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "handleRef": {
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "current"
          ],
          "type": "object"
        },
        "ownerC": {
          "properties": {
            "current": {
              "properties": {
                "handleFields": {
                  "items": {
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "value": {
                        "pattern": "^[0-9a-zA-ZÀ-ÖØ-öø-ÿ /&()+,.@_-]+$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "name",
                      "value"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "handleRef": {
                  "type": "string"
                }
              },
              "type": "object"
            },
            "desired": {
              "properties": {
                "handleFields": {
                  "items": {
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "value": {
                        "pattern": "^[0-9a-zA-ZÀ-ÖØ-öø-ÿ /&()+,.@_-]+$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "name",
                      "value"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "handleRef": {
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "current"
          ],
          "type": "object"
        }
      },
      "required": [
        "ownerC"
      ],
      "type": "object"
    },
    "nameservers": {
      "items": {
        "format": "idn-hostname",
        "type": "string"
      },
      "type": "array",
      "uniqueItems": true
    },
    "processes": {
      "items": {
        "properties": {
          "error": {
            "type": "string"
          },
          "lastUpdate": {
            "format": "date-time",
            "type": "string"
          },
          "processType": {
            "enum": [
              "UNSPECIFIED",
              "REGISTER",
              "TRANSFER",
              "DELETE",
              "TRANSIT",
              "RESTORE",
              "UPDATE",
              "TRANSFER_OUT",
              "OWNER_CHANGE",
              "DECLARE_REQUESTED"
            ],
            "type": "string"
          },
          "state": {
            "enum": [
              "UNSPECIFIED",
              "REQUESTED",
              "FAILED"
            ],
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "statusCode": {
            "type": "string"
          },
          "transactionId": {
            "type": "string"
          }
        },
        "required": [
          "transactionId",
          "processType",
          "state",
          "lastUpdate"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "projectId": {
      "format": "uuid",
      "type": "string"
    },
    "scheduledDeletionDate": {
      "format": "date-time",
      "type": "string"
    },
    "transferInAuthCode": {
      "type": "string"
    },
    "usesDefaultNameserver": {
      "type": "boolean"
    }
  },
  "required": [
    "domainId",
    "domain",
    "projectId",
    "deleted",
    "nameservers",
    "handles",
    "connected",
    "usesDefaultNameserver",
    "hasAuthCode"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/domains/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.getDomain({
  "domainId": "string"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetDomainRequest(
  domainId: "string"
));
$response = $client->domain()->getDomain($request);

var_dump($response->getBody();