# Waldur API

> Auto-generated Python SDK for the Waldur API (version 8.0.7-rc.22-dev.20260401112751).
> This SDK is generated from an OpenAPI specification using openapi-python-client.

## Quick Start

```python
from waldur_api_client import AuthenticatedClient

client = AuthenticatedClient(base_url="https://your-waldur-instance.com/", token="your-api-token")

# Example: list customers
from waldur_api_client.api.customers import customers_list
customers = customers_list.sync(client=client)

# Each endpoint module provides: sync(), sync_detailed(), sync_all(),
#   asyncio(), asyncio_detailed(), asyncio_all()
```

## Documentation Files

- [api-map.md](api-map.md) — Endpoints organized by domain with descriptions
- [llms-full.txt](llms-full.txt) — Complete flat reference of every endpoint with parameters

## SDK Structure

```
waldur_api_client/
  client.py              # AuthenticatedClient and Client classes
  api/<domain>/          # One directory per API domain (tag)
    <operation_id>.py    # One file per endpoint
  models/                # Request/response data models
```

## API Domains

- **access-subnets** (7 endpoints)
- **admin** (62 endpoints)
- **admin-announcements** (7 endpoints)
- **api-auth** (14 endpoints)
- **assignment-batches** (10 endpoints)
- **assignment-items** (12 endpoints)
- **auth-tokens** (4 endpoints)
- **auth-valimo** (2 endpoints)
- **autoprovisioning-rules** (7 endpoints)
- **aws-images** (3 endpoints)
- **aws-instances** (15 endpoints)
- **aws-regions** (3 endpoints)
- **aws-sizes** (3 endpoints)
- **aws-volumes** (13 endpoints)
- **azure-images** (3 endpoints)
- **azure-locations** (3 endpoints)
- **azure-public-ips** (11 endpoints)
- **azure-resource-groups** (3 endpoints)
- **azure-sizes** (3 endpoints)
- **azure-sql-databases** (11 endpoints)
- **azure-sql-servers** (12 endpoints)
- **azure-virtualmachines** (14 endpoints)
- **backend-resource-requests** (7 endpoints)
- **backend-resources** (6 endpoints)
- **billing-total-cost** (1 endpoint)
- **booking-offerings** (6 endpoints)
- **booking-resources** (5 endpoints)
- **broadcast-message-templates** (7 endpoints)
- **broadcast-messages** (11 endpoints)
- **call-assignment-configurations** (7 endpoints)
- **call-managing-organisations** (18 endpoints)
- **call-proposal-project-role-mappings** (7 endpoints)
- **call-reviewer-pools** (7 endpoints)
- **call-rounds** (4 endpoints)
- **celery-stats** (1 endpoint)
- **chat** (1 endpoint)
- **chat-messages** (1 endpoint)
- **chat-quota** (2 endpoints)
- **chat-sessions** (3 endpoints)
- **chat-threads** (5 endpoints)
- **chat-tools** (1 endpoint)
- **checklists-admin** (8 endpoints)
- **checklists-admin-question-dependencies** (7 endpoints)
- **checklists-admin-question-options** (7 endpoints)
- **checklists-admin-questions** (7 endpoints)
- **coi-detection-jobs** (3 endpoints)
- **coi-disclosures** (4 endpoints)
- **component-user-usage-limits** (7 endpoints)
- **configuration** (1 endpoint)
- **conflicts-of-interest** (8 endpoints)
- **customer-credits** (10 endpoints)
- **customer-permissions-reviews** (4 endpoints)
- **customer-quotas** (2 endpoints)
- **customers** (28 endpoints)
- **daily-quotas** (1 endpoint)
- **data-access-logs** (4 endpoints)
- **database-stats** (1 endpoint)
- **debug** (8 endpoints)
- **digitalocean-droplets** (15 endpoints)
- **digitalocean-images** (3 endpoints)
- **digitalocean-regions** (3 endpoints)
- **digitalocean-sizes** (3 endpoints)
- **email-logs** (3 endpoints)
- **event-subscription-queues** (4 endpoints)
- **event-subscriptions** (6 endpoints)
- **events** (9 endpoints)
- **events-stats** (2 endpoints)
- **expertise-categories** (3 endpoints)
- **external-links** (7 endpoints)
- **feature-values** (1 endpoint)
- **financial-reports** (3 endpoints)
- **freeipa-profiles** (7 endpoints)
- **google-auth** (6 endpoints)
- **hooks** (2 endpoints)
- **hooks-email** (7 endpoints)
- **hooks-web** (7 endpoints)
- **identity-bridge** (4 endpoints)
- **identity-providers** (9 endpoints)
- **invoice** (1 endpoint)
- **invoice-items** (17 endpoints)
- **invoices** (15 endpoints)
- **keycloak-groups** (3 endpoints)
- **keycloak-user-group-memberships** (7 endpoints)
- **keys** (7 endpoints)
- **lexis-links** (7 endpoints)
- **maintenance-announcement-offerings** (7 endpoints)
- **maintenance-announcement-template-offerings** (7 endpoints)
- **maintenance-announcements** (14 endpoints)
- **maintenance-announcements-template** (7 endpoints)
- **managed-rancher-cluster-resources** (4 endpoints)
- **marketplace-article-code-update** (2 endpoints)
- **marketplace-attribute-options** (7 endpoints)
- **marketplace-attributes** (7 endpoints)
- **marketplace-bookings** (1 endpoint)
- **marketplace-categories** (7 endpoints)
- **marketplace-category-columns** (7 endpoints)
- **marketplace-category-component-usages** (3 endpoints)
- **marketplace-category-components** (7 endpoints)
- **marketplace-category-groups** (7 endpoints)
- **marketplace-category-help-articles** (7 endpoints)
- **marketplace-component-usages** (6 endpoints)
- **marketplace-component-user-usages** (3 endpoints)
- **marketplace-course-accounts** (7 endpoints)
- **marketplace-customer-component-usage-policies** (9 endpoints)
- **marketplace-customer-estimated-cost-policies** (9 endpoints)
- **marketplace-customer-service-accounts** (8 endpoints)
- **marketplace-demo-presets** (5 endpoints)
- **marketplace-global-categories** (1 endpoint)
- **marketplace-integration-statuses** (3 endpoints)
- **marketplace-offering-estimated-cost-policies** (9 endpoints)
- **marketplace-offering-files** (5 endpoints)
- **marketplace-offering-permissions** (3 endpoints)
- **marketplace-offering-permissions-log** (3 endpoints)
- **marketplace-offering-referrals** (3 endpoints)
- **marketplace-offering-terms-of-service** (7 endpoints)
- **marketplace-offering-usage-policies** (9 endpoints)
- **marketplace-offering-user-checklist-completions** (3 endpoints)
- **marketplace-offering-user-roles** (7 endpoints)
- **marketplace-offering-users** (28 endpoints)
- **marketplace-orders** (23 endpoints)
- **marketplace-plan-components** (3 endpoints)
- **marketplace-plans** (17 endpoints)
- **marketplace-plugins** (1 endpoint)
- **marketplace-project-estimated-cost-policies** (9 endpoints)
- **marketplace-project-service-accounts** (8 endpoints)
- **marketplace-project-update-requests** (5 endpoints)
- **marketplace-provider-offerings** (76 endpoints)
- **marketplace-provider-resources** (37 endpoints)
- **marketplace-public-api** (2 endpoints)
- **marketplace-public-offerings** (5 endpoints)
- **marketplace-related-customers** (1 endpoint)
- **marketplace-remote-synchronisations** (8 endpoints)
- **marketplace-resource-offerings** (1 endpoint)
- **marketplace-resource-users** (5 endpoints)
- **marketplace-resources** (31 endpoints)
- **marketplace-robot-accounts** (12 endpoints)
- **marketplace-runtime-states** (1 endpoint)
- **marketplace-screenshots** (7 endpoints)
- **marketplace-script-async-dry-run** (3 endpoints)
- **marketplace-script-dry-run** (2 endpoints)
- **marketplace-script-sync-resource** (1 endpoint)
- **marketplace-sections** (7 endpoints)
- **marketplace-service-providers** (32 endpoints)
- **marketplace-site-agent-connection-stats** (1 endpoint)
- **marketplace-site-agent-identities** (9 endpoints)
- **marketplace-site-agent-processors** (4 endpoints)
- **marketplace-site-agent-services** (7 endpoints)
- **marketplace-site-agent-stats** (1 endpoint)
- **marketplace-site-agent-task-stats** (1 endpoint)
- **marketplace-slurm-periodic-usage-policies** (16 endpoints)
- **marketplace-software-catalogs** (11 endpoints)
- **marketplace-software-packages** (7 endpoints)
- **marketplace-software-targets** (7 endpoints)
- **marketplace-software-versions** (7 endpoints)
- **marketplace-stats** (98 endpoints)
- **marketplace-tags** (7 endpoints)
- **marketplace-user-offering-consents** (8 endpoints)
- **media** (1 endpoint)
- **metadata** (4 endpoints)
- **my-assignment-batches** (3 endpoints)
- **notification-messages** (9 endpoints)
- **notification-messages-templates** (8 endpoints)
- **offering-keycloak-groups** (16 endpoints)
- **offering-keycloak-memberships** (5 endpoints)
- **onboarding** (2 endpoints)
- **onboarding-justifications** (11 endpoints)
- **onboarding-question-metadata** (7 endpoints)
- **onboarding-verifications** (17 endpoints)
- **openportal-allocation-user-usage** (3 endpoints)
- **openportal-allocations** (12 endpoints)
- **openportal-associations** (3 endpoints)
- **openportal-managed-projects** (9 endpoints)
- **openportal-project-template** (8 endpoints)
- **openportal-projectinfo** (9 endpoints)
- **openportal-remote-allocations** (12 endpoints)
- **openportal-remote-associations** (3 endpoints)
- **openportal-unmanaged-projects** (19 endpoints)
- **openportal-userinfo** (10 endpoints)
- **openstack** (13 endpoints)
- **openstack-backups** (11 endpoints)
- **openstack-external-networks** (3 endpoints)
- **openstack-flavors** (5 endpoints)
- **openstack-floating-ips** (11 endpoints)
- **openstack-health-monitors** (7 endpoints)
- **openstack-images** (5 endpoints)
- **openstack-instance-availability-zones** (3 endpoints)
- **openstack-instances** (22 endpoints)
- **openstack-listeners** (7 endpoints)
- **openstack-loadbalancers** (10 endpoints)
- **openstack-marketplace-tenants** (5 endpoints)
- **openstack-migrations** (7 endpoints)
- **openstack-network-rbac-policies** (7 endpoints)
- **openstack-networks** (14 endpoints)
- **openstack-pool-members** (7 endpoints)
- **openstack-pools** (7 endpoints)
- **openstack-ports** (17 endpoints)
- **openstack-routers** (10 endpoints)
- **openstack-security-groups** (11 endpoints)
- **openstack-server-groups** (9 endpoints)
- **openstack-snapshots** (12 endpoints)
- **openstack-subnets** (12 endpoints)
- **openstack-tenants** (22 endpoints)
- **openstack-volume-availability-zones** (3 endpoints)
- **openstack-volume-types** (5 endpoints)
- **openstack-volumes** (14 endpoints)
- **organization-groups** (7 endpoints)
- **override-settings** (2 endpoints)
- **payment-profiles** (8 endpoints)
- **payments** (9 endpoints)
- **project-credits** (7 endpoints)
- **project-end-date-change-requests** (7 endpoints)
- **project-permissions-reviews** (4 endpoints)
- **project-quotas** (2 endpoints)
- **project-types** (3 endpoints)
- **projects** (21 endpoints)
- **promotions-campaigns** (10 endpoints)
- **proposal-proposals** (28 endpoints)
- **proposal-protected-calls** (62 endpoints)
- **proposal-public-calls** (4 endpoints)
- **proposal-requested-offerings** (5 endpoints)
- **proposal-requested-resources** (3 endpoints)
- **proposal-reviews** (9 endpoints)
- **provider-invoice-items** (3 endpoints)
- **public-maintenance-announcements** (3 endpoints)
- **query** (1 endpoint)
- **rabbitmq-overview** (1 endpoint)
- **rabbitmq-stats** (2 endpoints)
- **rabbitmq-user-stats** (1 endpoint)
- **rabbitmq-vhost-stats** (1 endpoint)
- **rancher-apps** (11 endpoints)
- **rancher-catalogs** (8 endpoints)
- **rancher-cluster-security-groups** (5 endpoints)
- **rancher-cluster-templates** (3 endpoints)
- **rancher-clusters** (11 endpoints)
- **rancher-hpas** (13 endpoints)
- **rancher-ingresses** (13 endpoints)
- **rancher-namespaces** (3 endpoints)
- **rancher-nodes** (13 endpoints)
- **rancher-projects** (4 endpoints)
- **rancher-role-templates** (3 endpoints)
- **rancher-services** (13 endpoints)
- **rancher-template-versions** (1 endpoint)
- **rancher-templates** (3 endpoints)
- **rancher-users** (3 endpoints)
- **rancher-workloads** (10 endpoints)
- **remote-eduteams** (1 endpoint)
- **remote-waldur-api** (19 endpoints)
- **reviewer-bids** (11 endpoints)
- **reviewer-invitations** (3 endpoints)
- **reviewer-profiles** (36 endpoints)
- **reviewer-suggestions** (6 endpoints)
- **roles** (10 endpoints)
- **service-settings** (3 endpoints)
- **slurm-allocation-user-usage** (3 endpoints)
- **slurm-allocations** (12 endpoints)
- **slurm-associations** (3 endpoints)
- **slurm-jobs** (11 endpoints)
- **stats** (5 endpoints)
- **support** (14 endpoints)
- **support-attachments** (5 endpoints)
- **support-comments** (6 endpoints)
- **support-feedback-average-report** (1 endpoint)
- **support-feedback-report** (1 endpoint)
- **support-feedbacks** (4 endpoints)
- **support-issue-statuses** (7 endpoints)
- **support-issues** (9 endpoints)
- **support-jira-webhook** (1 endpoint)
- **support-priorities** (3 endpoints)
- **support-request-types** (3 endpoints)
- **support-request-types-admin** (10 endpoints)
- **support-smax-webhook** (1 endpoint)
- **support-statistics** (1 endpoint)
- **support-templates** (9 endpoints)
- **support-users** (3 endpoints)
- **support-zammad-webhook** (1 endpoint)
- **sync-issues** (2 endpoints)
- **system-logs** (7 endpoints)
- **user-action-executions** (3 endpoints)
- **user-action-providers** (3 endpoints)
- **user-actions** (10 endpoints)
- **user-agreements** (7 endpoints)
- **user-group-invitations** (10 endpoints)
- **user-invitations** (16 endpoints)
- **user-permission-requests** (7 endpoints)
- **user-permissions** (3 endpoints)
- **users** (33 endpoints)
- **version** (1 endpoint)
- **vmware-clusters** (3 endpoints)
- **vmware-datastores** (3 endpoints)
- **vmware-disks** (9 endpoints)
- **vmware-folders** (3 endpoints)
- **vmware-limits** (1 endpoint)
- **vmware-networks** (3 endpoints)
- **vmware-ports** (8 endpoints)
- **vmware-templates** (3 endpoints)
- **vmware-virtual-machine** (21 endpoints)
