Create an extension instance

POST/v2/extension-instances

API version

v2

Request method

POST

Operation ID

extension-create-extension-instance

Request

Responses

Format

application/json

Description

The ExtensionInstance ID.

• idstring (uuid)required

Content-Type: application/json

{
  "id": "f0f86186-0a5a-45b2-aa33-502777496347"
}

{
  "properties": {
    "id": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

Usage examples

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"consentedScopes":["string"],"context":"project","contextId":"f0f86186-0a5a-45b2-aa33-502777496347","extensionId":"f0f86186-0a5a-45b2-aa33-502777496347","variantKey":"string"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/extension-instances

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.extensionCreateExtensionInstance({
  "data": {
    "consentedScopes": [
      "string"
    ],
    "context": "project",
    "contextId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "variantKey": "string"
  }
});

assertStatus(response, 201);
  

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionCreateExtensionInstance\ExtensionCreateExtensionInstanceRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionCreateExtensionInstance\ExtensionCreateExtensionInstanceRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new ExtensionCreateExtensionInstanceRequest(
  body: $body
));
$response = $client->marketplace()->extensionCreateExtensionInstance($request);

var_dump($response->getBody();