Skip to content

Metadata

Operations Summary

Method Endpoint Description
GET /api/metadata/events/ Get event metadata
GET /api/metadata/features/ Get feature flag metadata
GET /api/metadata/permissions/ Get permission metadata
GET /api/metadata/settings/ Get overridable settings metadata

Get event metadata

Retrieves metadata for all available event types, grouped by categories. This endpoint is publicly accessible and is useful for building UIs for event filtering or webhook configuration.

1
2
3
4
http \
  GET \
  https://api.example.com/api/metadata/events/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.metadata import metadata_events_retrieve # (1)

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

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

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

200 -

Field Type Description
event_groups object (free-form) Map of event group keys to lists of event type enums from EventType

Get feature flag metadata

Retrieves metadata for all available feature flags, including their keys, descriptions, and grouping sections. This endpoint is publicly accessible and helps UIs to dynamically render feature-related settings.

1
2
3
4
http \
  GET \
  https://api.example.com/api/metadata/features/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.metadata import metadata_features_retrieve # (1)

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

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

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

200 -

Field Type Description
features array of objects List of feature sections with descriptions
feature_enums object (free-form) Nested feature enum values by section

Get permission metadata

Retrieves metadata about roles, permissions, and their descriptions. This endpoint is publicly accessible and provides data needed for UI components, such as role selection dropdowns and permission management interfaces.

1
2
3
4
http \
  GET \
  https://api.example.com/api/metadata/permissions/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.metadata import metadata_permissions_retrieve # (1)

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

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

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

200 -

Field Type Description
roles object (free-form) Map of role keys to role enum values from RoleEnum
permissions object (free-form) Map of permission keys to permission enum values from PermissionEnum
permission_map object (free-form) Map of resource types to create permission enums
permission_descriptions array of objects Grouped permission descriptions for UI

Get overridable settings metadata

Retrieves metadata for all settings that can be configured via the Constance backend. This includes setting keys, human-readable descriptions, default values, and types. This endpoint is publicly accessible.

1
2
3
4
http \
  GET \
  https://api.example.com/api/metadata/settings/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.metadata import metadata_settings_retrieve # (1)

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

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

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

200 -

Field Type Description
settings array of objects List of settings sections with configuration items