Update the auth code of a Domain

PATCH/domains/{domainId}/auth-code/

API version

v2

Request method

PATCH

Operation ID

domain-update-domain-auth-code

---

Update an incorrect auth code of an ongoing/failed Domain transfer. This route will also restart the transfer itself.

Request

• domainIdstring (uuid)

  required

Responses

Format

application/json

Description

OK

Schema documentation

• isAsyncboolean
• transactionIdstring

Example

{
  "isAsync": true,
  "transactionId": "string"
}

JSON Schema

{
  "properties": {
    "isAsync": {
      "type": "boolean"
    },
    "transactionId": {
      "type": "string"
    }
  },
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X PATCH \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/domains/f0f86186-0a5a-45b2-aa33-502777496347/auth-code

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.updateDomainAuthCode({
  "domainId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

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

$request = (new UpdateDomainAuthCodeRequest(
  domainId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->domain()->updateDomainAuthCode($request);

var_dump($response->getBody();