Rotate the secret for an extension instance

PUT /v2/contributors/{contributorId}/extensions/{extensionId}/extension-instances/{extensionInstanceId}/secret/

API version

v2

Request method

PUT

Operation ID

contributor-rotate-secret-for-extension-instance

---

Request

• contributorIdstring

  required
• extensionIdstring (uuid)

  required
• extensionInstanceIdstring (uuid)

  required

Responses

Format

application/json

Beschreibung

Secret rotated successfully.

Schema-Dokumentation

• secretstring

  required
• webhookResultobject

  required
  • failureboolean

    required
  • statusCodestring

    The status code returned by the external application.

Beispiel

{
  "secret": "string",
  "webhookResult": {
    "failure": true,
    "statusCode": "string"
  }
}

JSON Schema

{
  "properties": {
    "secret": {
      "type": "string"
    },
    "webhookResult": {
      "properties": {
        "failure": {
          "type": "boolean"
        },
        "statusCode": {
          "description": "The status code returned by the external application.",
          "type": "string"
        }
      },
      "required": [
        "failure"
      ],
      "type": "object"
    }
  },
  "required": [
    "secret",
    "webhookResult"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X PUT \
    -d '{"allowWebhookFailure":true}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/contributors/string/extensions/f0f86186-0a5a-45b2-aa33-502777496347/extension-instances/f0f86186-0a5a-45b2-aa33-502777496347/secret

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.marketplace.contributorRotateSecretForExtensionInstance({
  "contributorId": "string",
  "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "extensionInstanceId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "allowWebhookFailure": true
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ContributorRotateSecretForExtensionInstance\ContributorRotateSecretForExtensionInstanceRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ContributorRotateSecretForExtensionInstance\ContributorRotateSecretForExtensionInstanceRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new ContributorRotateSecretForExtensionInstanceRequest(
  contributorId: "string",
  extensionId: "f0f86186-0a5a-45b2-aa33-502777496347",
  extensionInstanceId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->marketplace()->contributorRotateSecretForExtensionInstance($request);

var_dump($response->getBody();