List extension instances

GET /v2/extension-instances/

API version

v2

Request method

GET

Operation ID

extension-list-extension-instances

---

Request

Responses

Format

application/json

Description

OK

Schema documentation

• Array[
• *object
  • 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-09-19T00:25:42.340Z",
    "disabled": true,
    "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "pendingInstallation": true,
    "pendingRemoval": true
  }
]

JSON Schema

{
  "items": {
    "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"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/extension-instances?limit=50&page=1&context=project&contextId=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.extensionListExtensionInstances({
  "queryParameters": {
    "limit": 50,
    "page": 1,
    "context": "project",
    "contextId": "f0f86186-0a5a-45b2-aa33-502777496347"
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ExtensionListExtensionInstancesRequest())
  ->withLimit(50)
  ->withPage(1)
  ->withContext("project")
  ->withContextId("f0f86186-0a5a-45b2-aa33-502777496347");
$response = $client->marketplace()->extensionListExtensionInstances($request);

var_dump($response->getBody();