Skip to content

Marketplace Plugins

Operations Summary

Method Endpoint Description
GET /api/marketplace-plugins/ List available marketplace plugins and their components

List available marketplace plugins and their components

1
2
3
4
5
6
7
    Returns a list of all registered marketplace plugins (offering types) and the components
    associated with each. This endpoint is public and does not require authentication.

    Each plugin entry includes:
    - `offering_type`: A unique identifier for the plugin.
    - `components`: A list of components provided by the plugin, each with its `type`, `name`, `measured_unit`, and `billing_type`.
    - `available_limits`: A list of component types that support user-defined limits for this plugin.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-plugins/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plugins import marketplace_plugins_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plugins_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_plugins_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplacePluginsList } from 'waldur-js-client';

try {
  const response = await marketplacePluginsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
offering_type string
components array of objects
components.type string
components.name string
components.measured_unit string
components.billing_type string
available_limits array of strings