List Domain-Migrations belonging to a Project

GET/v2/projects/{projectId}/domain-migrations/

API version

v2

Request method

GET

Operation ID

domain-migration-list-migrations-by-project-id

---

Request

• projectIdstring

  required

  ID of the Project to list Domain-Migrations for.

Responses

Format

application/json

Description

OK

Schema documentation

• Array[
  • *object
    • createdAtstring (date-time)
    • domainsarray of object

      required
      • Array[
        • *object
          • coabDataobject
            • dnsRecordsarray of object
              • Array[
                • *object
                  • namestring
                  • ttlinteger (≥ 60)

                    required
                  • typestring (one of: A, AAAA, TXT, MX, CNAME, SRV, CAA, NS)

                    required
                  • valuestring

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

                      required
                    • valuestring

                      required
                  ]
              • handleRefstring
            • nameserversarray of string
              • Array[
                • *string
                ]
            • subdomainsarray of object
              • Array[
                • *object
                  • dnsRecordsarray of object

                    required
                    • Array[
                      • *object
                        • namestring
                        • ttlinteger (≥ 60)

                          required
                        • typestring (one of: A, AAAA, TXT, MX, CNAME, SRV, CAA, NS)

                          required
                        • valuestring

                          required
                      ]
                  • hostnamestring

                    required
                  • targetstring
                ]
          • domainstring (idn-hostname)

            required
          • domainIdstring (uuid)

            required
          • statestring (one of: pending, succeeded, failed)

            required
        ]
    • finishedAtstring (date-time)
    • idstring (uuid)

      required
    • pAccountstring

      required
    • projectIdstring (uuid)

      required
  ]

Example

Content-Type: application/json

[
  {
    "createdAt": "1985-10-26T01:21:00.000Z",
    "domains": [
      {
        "coabData": {
          "dnsRecords": [
            {
              "name": "string",
              "ttl": 123,
              "type": "A",
              "value": "string"
            }
          ],
          "handleData": {
            "handleFields": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "handleRef": "string"
          },
          "nameservers": [
            "string"
          ],
          "subdomains": [
            {
              "dnsRecords": [
                {
                  "name": "string",
                  "ttl": 123,
                  "type": "A",
                  "value": "string"
                }
              ],
              "hostname": "string",
              "target": "string"
            }
          ]
        },
        "domain": "some-hostname.example",
        "domainId": "f0f86186-0a5a-45b2-aa33-502777496347",
        "state": "pending"
      }
    ],
    "finishedAt": "1985-10-26T01:21:00.000Z",
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "pAccount": "string",
    "projectId": "f0f86186-0a5a-45b2-aa33-502777496347"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "createdAt": {
        "format": "date-time",
        "type": "string"
      },
      "domains": {
        "items": {
          "properties": {
            "coabData": {
              "properties": {
                "dnsRecords": {
                  "items": {
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "ttl": {
                        "maximum": 86400,
                        "minimum": 60,
                        "type": "integer"
                      },
                      "type": {
                        "enum": [
                          "A",
                          "AAAA",
                          "TXT",
                          "MX",
                          "CNAME",
                          "SRV",
                          "CAA",
                          "NS"
                        ],
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "type",
                      "value",
                      "ttl"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "handleData": {
                  "properties": {
                    "handleFields": {
                      "items": {
                        "properties": {
                          "name": {
                            "type": "string"
                          },
                          "value": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "name",
                          "value"
                        ],
                        "type": "object"
                      },
                      "type": "array"
                    },
                    "handleRef": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                },
                "nameservers": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "subdomains": {
                  "items": {
                    "properties": {
                      "dnsRecords": {
                        "items": {
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "ttl": {
                              "maximum": 86400,
                              "minimum": 60,
                              "type": "integer"
                            },
                            "type": {
                              "enum": [
                                "A",
                                "AAAA",
                                "TXT",
                                "MX",
                                "CNAME",
                                "SRV",
                                "CAA",
                                "NS"
                              ],
                              "type": "string"
                            },
                            "value": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "type",
                            "value",
                            "ttl"
                          ],
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "hostname": {
                        "type": "string"
                      },
                      "target": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "hostname",
                      "dnsRecords"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            },
            "domain": {
              "format": "idn-hostname",
              "type": "string"
            },
            "domainId": {
              "format": "uuid",
              "type": "string"
            },
            "state": {
              "enum": [
                "pending",
                "succeeded",
                "failed"
              ],
              "type": "string"
            }
          },
          "required": [
            "domain",
            "domainId",
            "state"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "finishedAt": {
        "format": "date-time",
        "type": "string"
      },
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "pAccount": {
        "type": "string"
      },
      "projectId": {
        "format": "uuid",
        "type": "string"
      }
    },
    "required": [
      "id",
      "pAccount",
      "projectId",
      "domains"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

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

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

assertStatus(response, 200);
  

PHP SDK

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

$request = (new MigrationListMigrationsByProjectIdRequest(
  projectId: "string"
));
$response = $client->domain()->migrationListMigrationsByProjectId($request);

var_dump($response->getBody();