Get an extension instance

GET/extension-instances/{extensionInstanceId}/

API version

v2

Request method

GET

Operation ID

extension-get-extension-instance

---

Request

• extensionInstanceIdstring (uuid)

  required

Responses

Format

application/json

Description

OK

Schema documentation

• aggregateReferenceobject

  required
  • aggregatestring

    required
  • domainstring

    required
  • idstring (uuid)

    required
• consentedScopesarray of string

  required
  • Array[
  • *string
  ]

createdAtstring (date-time)

disabledboolean

required

extensionIdstring (uuid)

required

idstring (uuid)

required

pendingInstallationboolean

required

pendingRemovalboolean

required

Example

{
  "aggregateReference": {
    "aggregate": "string",
    "domain": "string",
    "id": "f0f86186-0a5a-45b2-aa33-502777496347"
  },
  "consentedScopes": [
    "string"
  ],
  "createdAt": "2024-11-21T11:15:12.596Z",
  "disabled": true,
  "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "pendingInstallation": true,
  "pendingRemoval": true
}

JSON Schema

{
  "properties": {
    "aggregateReference": {
      "properties": {
        "aggregate": {
          "type": "string"
        },
        "domain": {
          "type": "string"
        },
        "id": {
          "format": "uuid",
          "type": "string"
        }
      },
      "required": [
        "id",
        "domain",
        "aggregate"
      ],
      "type": "object"
    },
    "consentedScopes": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "disabled": {
      "default": false,
      "type": "boolean"
    },
    "extensionId": {
      "format": "uuid",
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "pendingInstallation": {
      "default": false,
      "type": "boolean"
    },
    "pendingRemoval": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "extensionId",
    "disabled",
    "pendingInstallation",
    "pendingRemoval",
    "consentedScopes",
    "aggregateReference"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/extension-instances/f0f86186-0a5a-45b2-aa33-502777496347

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.extensionGetExtensionInstance({
  "extensionInstanceId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ExtensionGetExtensionInstanceRequest(
  extensionInstanceId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->marketplace()->extensionGetExtensionInstance($request);

var_dump($response->getBody();