Relocate an external Project to mittwald

POST/relocation/

API version

v2

Request method

POST

Operation ID

relocation-create-relocation

---

Give mittwald access to your Provider and let them move your Project to mittwald.

Request

Responses

No response content specified.

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"additionalServices":{"dataCompare":"default"},"allDomains":true,"allowPasswordChange":true,"articleType":"cms-hosting","contact":{"email":"email@mittwald.example","firstName":"string","lastName":"string","phoneNumber":"string"},"domains":[{"authCode":"string","domainOwnerData":"string","name":"string"}],"notes":"string","prices":{"positions":[{"name":"string","price":123}],"total":123},"provider":{"loginUrl":"string","name":"string","password":"string","sourceAccount":"string","userName":"string"},"target":{"organisation":"string","product":"string","projectName":"string","system":"kc"}}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/relocation

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.relocation.createRelocation({
  "data": {
    "additionalServices": {
      "dataCompare": "default"
    },
    "allDomains": true,
    "allowPasswordChange": true,
    "articleType": "cms-hosting",
    "contact": {
      "email": "email@mittwald.example",
      "firstName": "string",
      "lastName": "string",
      "phoneNumber": "string"
    },
    "domains": [
      {
        "authCode": "string",
        "domainOwnerData": "string",
        "name": "string"
      }
    ],
    "notes": "string",
    "prices": {
      "positions": [
        {
          "name": "string",
          "price": 123
        }
      ],
      "total": 123
    },
    "provider": {
      "loginUrl": "string",
      "name": "string",
      "password": "string",
      "sourceAccount": "string",
      "userName": "string"
    },
    "target": {
      "organisation": "string",
      "product": "string",
      "projectName": "string",
      "system": "kc"
    }
  }
});

assertStatus(response, 204);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Relocation\CreateRelocation\CreateRelocationRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Relocation\CreateRelocation\CreateRelocationRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new CreateRelocationRequest(
  body: $body
));
$response = $client->relocation()->createRelocation($request);

var_dump($response->getBody();