rotate a License's key, i.e. revoke the old and generate a new one

POST/licenses/{licenseId}/actions/rotate-key/

API version

v2

Request method

POST

Operation ID

license-rotate-license-key

---

Request

• licenseIdstring (uuid)

  required

  ID if the License to rotate the key of.

Responses

Format

application/json

Beschreibung

OK

Schema-Dokumentation

• keyReferenceone of 2 alternatives
  • Alternativeobject
    • keystring

      required
  • Alternativeobject
    • externalKeystring

      required

Beispiel

Content-Type: application/json

{
  "keyReference": {
    "key": "Afdkj49dsfj3"
  }
}

JSON Schema

{
  "properties": {
    "keyReference": {
      "oneOf": [
        {
          "properties": {
            "key": {
              "example": "Afdkj49dsfj3",
              "type": "string"
            }
          },
          "required": [
            "key"
          ],
          "type": "object"
        },
        {
          "properties": {
            "externalKey": {
              "type": "string"
            }
          },
          "required": [
            "externalKey"
          ],
          "type": "object"
        }
      ]
    }
  },
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"externalKey":"string"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/licenses/f0f86186-0a5a-45b2-aa33-502777496347/actions/rotate-key

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.license.rotateLicenseKey({
  "licenseId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "externalKey": "string"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\License\RotateLicenseKey\RotateLicenseKeyRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\License\RotateLicenseKey\RotateLicenseKeyRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new RotateLicenseKeyRequest(
  licenseId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->license()->rotateLicenseKey($request);

var_dump($response->getBody();