# Waldur API — Full Endpoint Reference
# Version: 8.1.0-rc.9.dev.20260709113614
#
# Import pattern:
#   from waldur_api_client.api.<domain> import <operation_id>
#   result = <operation_id>.sync(client=client, ...)
#
# Each endpoint provides: sync(), sync_detailed(), sync_all(),
#   asyncio(), asyncio_detailed(), asyncio_all()

============================================================
## _matrix  (module: waldur_api_client.api._matrix)
============================================================

### _matrix_app_v1_transactions_update
PUT /_matrix/app/v1/transactions/{txn_id}
Summary: Matrix Application Service transaction webhook
Description: Receives event transactions from the Matrix homeserver. Authenticated via hs_token in the Authorization header.
Path parameters:
  - txn_id

============================================================
## access-subnets  (module: waldur_api_client.api.access_subnets)
============================================================

### access_subnets_list
GET /api/access-subnets/
Summary: List access subnets
Description: Retrieve a list of access subnets. Staff and support users can see all subnets, while other users can only see subnets associated with customers they have a role in.
Query parameters (4):
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description
  - inet — Inet

### access_subnets_count
HEAD /api/access-subnets/
Summary: List access subnets
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description
  - inet — Inet

### access_subnets_create
POST /api/access-subnets/
Summary: Create an access subnet
Description: Create a new access subnet for a customer.
Request body: yes

### access_subnets_retrieve
GET /api/access-subnets/{uuid}/
Summary: Retrieve access subnet
Description: Fetch the details of a specific access subnet by its UUID.
Path parameters:
  - uuid

### access_subnets_update
PUT /api/access-subnets/{uuid}/
Summary: Update an access subnet
Description: Update an existing access subnet.
Path parameters:
  - uuid
Request body: yes

### access_subnets_partial_update
PATCH /api/access-subnets/{uuid}/
Summary: Partially update an access subnet
Description: Partially update an existing access subnet.
Path parameters:
  - uuid
Request body: yes

### access_subnets_destroy
DELETE /api/access-subnets/{uuid}/
Summary: Delete an access subnet
Description: Delete an existing access subnet.
Path parameters:
  - uuid

============================================================
## admin  (module: waldur_api_client.api.admin)
============================================================

### admin_arrow_billing_sync_items_list
GET /api/admin/arrow/billing-sync-items/
Query parameters (8):
  - arrow_line_reference
  - billing_sync
  - billing_sync_uuid
  - classification
  - has_compensation
  - report_period
  - subscription_reference
  - vendor_name

### admin_arrow_billing_sync_items_count
HEAD /api/admin/arrow/billing-sync-items/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - arrow_line_reference
  - billing_sync
  - billing_sync_uuid
  - classification
  - has_compensation
  - report_period
  - subscription_reference
  - vendor_name

### admin_arrow_billing_sync_items_retrieve
GET /api/admin/arrow/billing-sync-items/{uuid}/
Path parameters:
  - uuid

### admin_arrow_billing_syncs_list
GET /api/admin/arrow/billing-syncs/
Query parameters (9):
  - arrow_state
  - customer_mapping
  - customer_mapping_uuid
  - report_period
  - report_period_from
  - report_period_to
  - settings_uuid
  - state
  - statement_reference

### admin_arrow_billing_syncs_count
HEAD /api/admin/arrow/billing-syncs/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - arrow_state
  - customer_mapping
  - customer_mapping_uuid
  - report_period
  - report_period_from
  - report_period_to
  - settings_uuid
  - state
  - statement_reference

### admin_arrow_billing_syncs_cleanup_consumption
POST /api/admin/arrow/billing-syncs/cleanup_consumption/
Summary: Delete consumption records with optional dry-run preview
Description: Delete consumption records with optional dry-run preview.
Request body: yes

### admin_arrow_billing_syncs_consumption_statistics_retrieve
GET /api/admin/arrow/billing-syncs/consumption_statistics/
Summary: Get consumption statistics
Description: Get consumption statistics.

### admin_arrow_billing_syncs_consumption_statistics_count
HEAD /api/admin/arrow/billing-syncs/consumption_statistics/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### admin_arrow_billing_syncs_consumption_status_retrieve
GET /api/admin/arrow/billing-syncs/consumption_status/
Summary: Get current consumption sync status
Description: Get current consumption sync status.

### admin_arrow_billing_syncs_consumption_status_count
HEAD /api/admin/arrow/billing-syncs/consumption_status/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### admin_arrow_billing_syncs_fetch_billing_export
POST /api/admin/arrow/billing-syncs/fetch_billing_export/
Summary: Fetch raw billing export from Arrow API
Description: Fetch raw billing export from Arrow API.
Request body: yes

### admin_arrow_billing_syncs_fetch_consumption
POST /api/admin/arrow/billing-syncs/fetch_consumption/
Summary: Fetch raw consumption data from Arrow API
Description: Fetch raw consumption data from Arrow API.
Request body: yes

### admin_arrow_billing_syncs_fetch_license_info
POST /api/admin/arrow/billing-syncs/fetch_license_info/
Summary: Fetch license details from Arrow API
Description: Fetch license details from Arrow API.
Request body: yes

### admin_arrow_billing_syncs_pause_sync
POST /api/admin/arrow/billing-syncs/pause_sync/
Summary: Pause consumption sync operations
Description: Pause consumption sync operations.
Request body: yes

### admin_arrow_billing_syncs_pending_records_list
GET /api/admin/arrow/billing-syncs/pending_records/
Summary: List pending consumption records (not yet finalized)
Description: List pending consumption records (not yet finalized).
Query parameters (9):
  - arrow_state
  - customer_mapping
  - customer_mapping_uuid
  - report_period
  - report_period_from
  - report_period_to
  - settings_uuid
  - state
  - statement_reference

### admin_arrow_billing_syncs_pending_records_count
HEAD /api/admin/arrow/billing-syncs/pending_records/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - arrow_state
  - customer_mapping
  - customer_mapping_uuid
  - report_period
  - report_period_from
  - report_period_to
  - settings_uuid
  - state
  - statement_reference

### admin_arrow_billing_syncs_reconcile
POST /api/admin/arrow/billing-syncs/reconcile/
Summary: Trigger reconciliation for a specific period
Description: Trigger reconciliation for a specific period.
Request body: yes

### admin_arrow_billing_syncs_resume_sync
POST /api/admin/arrow/billing-syncs/resume_sync/
Summary: Resume consumption sync operations
Description: Resume consumption sync operations.
Request body: yes

### admin_arrow_billing_syncs_sync_resource_historical_consumption
POST /api/admin/arrow/billing-syncs/sync_resource_historical_consumption/
Summary: Sync historical consumption for a specific resource from Arrow
Description: Sync historical consumption for a specific resource from Arrow.
Request body: yes

### admin_arrow_billing_syncs_sync_resources
POST /api/admin/arrow/billing-syncs/sync_resources/
Summary: Sync Arrow IAAS subscriptions to Waldur Resources
Description: Sync Arrow IAAS subscriptions to Waldur Resources. Matches subscriptions by Vendor Subscription ID to resource backend_id. Updates resource report and current_usages fields. With force_import=True, auto-creates Customers and Projects from Arrow data.
Request body: yes

### admin_arrow_billing_syncs_trigger_consumption_sync
POST /api/admin/arrow/billing-syncs/trigger_consumption_sync/
Summary: Trigger consumption sync for a specific period
Description: Trigger consumption sync for a specific period.
Request body: yes

### admin_arrow_billing_syncs_trigger_reconciliation
POST /api/admin/arrow/billing-syncs/trigger_reconciliation/
Summary: Trigger reconciliation (check billing export and apply adjustments)
Description: Trigger reconciliation (check billing export and apply adjustments).
Request body: yes

### admin_arrow_billing_syncs_trigger_sync
POST /api/admin/arrow/billing-syncs/trigger_sync/
Summary: Trigger billing sync for a specific period
Description: Trigger billing sync for a specific period.
Request body: yes

### admin_arrow_billing_syncs_retrieve
GET /api/admin/arrow/billing-syncs/{uuid}/
Path parameters:
  - uuid

### admin_arrow_consumption_records_list
GET /api/admin/arrow/consumption-records/
Query parameters (10):
  - billing_period
  - billing_period_from
  - billing_period_to
  - customer_uuid
  - is_finalized
  - is_reconciled
  - license_reference
  - project_uuid
  - resource
  - resource_uuid

### admin_arrow_consumption_records_count
HEAD /api/admin/arrow/consumption-records/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (10):
  - billing_period
  - billing_period_from
  - billing_period_to
  - customer_uuid
  - is_finalized
  - is_reconciled
  - license_reference
  - project_uuid
  - resource
  - resource_uuid

### admin_arrow_consumption_records_retrieve
GET /api/admin/arrow/consumption-records/{uuid}/
Path parameters:
  - uuid

### admin_arrow_customer_mappings_list
GET /api/admin/arrow/customer-mappings/
Query parameters (7):
  - arrow_company_name
  - arrow_reference
  - is_active
  - settings
  - settings_uuid
  - waldur_customer
  - waldur_customer_uuid

### admin_arrow_customer_mappings_count
HEAD /api/admin/arrow/customer-mappings/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (7):
  - arrow_company_name
  - arrow_reference
  - is_active
  - settings
  - settings_uuid
  - waldur_customer
  - waldur_customer_uuid

### admin_arrow_customer_mappings_create
POST /api/admin/arrow/customer-mappings/
Request body: yes

### admin_arrow_customer_mappings_available_customers_retrieve
GET /api/admin/arrow/customer-mappings/available_customers/
Summary: Get available Arrow customers that are not yet mapped, with suggestions for Waldur organization matches
Description: Get available Arrow customers that are not yet mapped, with suggestions for Waldur organization matches.

### admin_arrow_customer_mappings_available_customers_count
HEAD /api/admin/arrow/customer-mappings/available_customers/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### admin_arrow_customer_mappings_sync_from_arrow
POST /api/admin/arrow/customer-mappings/sync_from_arrow/
Summary: Sync customer list from Arrow and update arrow_company_name
Description: Sync customer list from Arrow and update arrow_company_name.
Request body: yes

### admin_arrow_customer_mappings_retrieve
GET /api/admin/arrow/customer-mappings/{uuid}/
Path parameters:
  - uuid

### admin_arrow_customer_mappings_update
PUT /api/admin/arrow/customer-mappings/{uuid}/
Path parameters:
  - uuid
Request body: yes

### admin_arrow_customer_mappings_partial_update
PATCH /api/admin/arrow/customer-mappings/{uuid}/
Path parameters:
  - uuid
Request body: yes

### admin_arrow_customer_mappings_destroy
DELETE /api/admin/arrow/customer-mappings/{uuid}/
Path parameters:
  - uuid

### admin_arrow_customer_mappings_billing_summary_retrieve
GET /api/admin/arrow/customer-mappings/{uuid}/billing_summary/
Summary: Get billing and consumption summary for this customer mapping
Description: Get billing and consumption summary for this customer mapping.
Path parameters:
  - uuid

### admin_arrow_customer_mappings_discover_licenses_retrieve
GET /api/admin/arrow/customer-mappings/{uuid}/discover_licenses/
Summary: Discover Arrow licenses for this customer and show linkable Waldur resources
Description: Discover Arrow licenses for this customer and show linkable Waldur resources.
Path parameters:
  - uuid

### admin_arrow_customer_mappings_fetch_arrow_data_retrieve
GET /api/admin/arrow/customer-mappings/{uuid}/fetch_arrow_data/
Summary: Fetch fresh consumption and billing data from Arrow API for this customer
Description: Fetch fresh consumption and billing data from Arrow API for this customer.
Path parameters:
  - uuid

### admin_arrow_customer_mappings_import_license
POST /api/admin/arrow/customer-mappings/{uuid}/import_license/
Summary: Import an Arrow license as a new Waldur resource
Description: Import an Arrow license as a new Waldur resource.
Path parameters:
  - uuid
Request body: yes

### admin_arrow_customer_mappings_link_resource
POST /api/admin/arrow/customer-mappings/{uuid}/link_resource/
Summary: Link a Waldur resource to an Arrow license by setting its backend_id
Description: Link a Waldur resource to an Arrow license by setting its backend_id.
Path parameters:
  - uuid
Request body: yes

### admin_arrow_settings_list
GET /api/admin/arrow/settings/
Query parameters (2):
  - is_active
  - sync_enabled

### admin_arrow_settings_count
HEAD /api/admin/arrow/settings/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - is_active
  - sync_enabled

### admin_arrow_settings_create
POST /api/admin/arrow/settings/
Request body: yes

### admin_arrow_settings_discover_customers
POST /api/admin/arrow/settings/discover_customers/
Summary: Discover Arrow customers and suggest mappings to Waldur customers
Description: Discover Arrow customers and suggest mappings to Waldur customers.
Request body: yes

### admin_arrow_settings_preview_settings
POST /api/admin/arrow/settings/preview_settings/
Summary: Preview settings configuration before saving
Description: Preview settings configuration before saving.
Request body: yes

### admin_arrow_settings_save_settings
POST /api/admin/arrow/settings/save_settings/
Summary: Save Arrow settings and customer mappings
Description: Save Arrow settings and customer mappings.
Request body: yes

### admin_arrow_settings_validate_credentials
POST /api/admin/arrow/settings/validate_credentials/
Summary: Validate Arrow API credentials without saving them
Description: Validate Arrow API credentials without saving them.
Request body: yes

### admin_arrow_settings_retrieve
GET /api/admin/arrow/settings/{uuid}/
Path parameters:
  - uuid

### admin_arrow_settings_update
PUT /api/admin/arrow/settings/{uuid}/
Path parameters:
  - uuid
Request body: yes

### admin_arrow_settings_partial_update
PATCH /api/admin/arrow/settings/{uuid}/
Path parameters:
  - uuid
Request body: yes

### admin_arrow_settings_destroy
DELETE /api/admin/arrow/settings/{uuid}/
Path parameters:
  - uuid

### admin_arrow_vendor_offering_mappings_list
GET /api/admin/arrow/vendor-offering-mappings/
Query parameters (6):
  - arrow_vendor_name
  - is_active
  - offering
  - offering_uuid
  - settings
  - settings_uuid

### admin_arrow_vendor_offering_mappings_count
HEAD /api/admin/arrow/vendor-offering-mappings/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - arrow_vendor_name
  - is_active
  - offering
  - offering_uuid
  - settings
  - settings_uuid

### admin_arrow_vendor_offering_mappings_create
POST /api/admin/arrow/vendor-offering-mappings/
Request body: yes

### admin_arrow_vendor_offering_mappings_vendor_choices_list
GET /api/admin/arrow/vendor-offering-mappings/vendor_choices/
Summary: Get vendor names from Arrow catalog API (IAAS category)
Description: Get vendor names from Arrow catalog API (IAAS category).
Query parameters (6):
  - arrow_vendor_name
  - is_active
  - offering
  - offering_uuid
  - settings
  - settings_uuid

### admin_arrow_vendor_offering_mappings_vendor_choices_count
HEAD /api/admin/arrow/vendor-offering-mappings/vendor_choices/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - arrow_vendor_name
  - is_active
  - offering
  - offering_uuid
  - settings
  - settings_uuid

### admin_arrow_vendor_offering_mappings_retrieve
GET /api/admin/arrow/vendor-offering-mappings/{uuid}/
Path parameters:
  - uuid

### admin_arrow_vendor_offering_mappings_update
PUT /api/admin/arrow/vendor-offering-mappings/{uuid}/
Path parameters:
  - uuid
Request body: yes

### admin_arrow_vendor_offering_mappings_partial_update
PATCH /api/admin/arrow/vendor-offering-mappings/{uuid}/
Path parameters:
  - uuid
Request body: yes

### admin_arrow_vendor_offering_mappings_destroy
DELETE /api/admin/arrow/vendor-offering-mappings/{uuid}/
Path parameters:
  - uuid

### admin_matrix_appservice_setup
POST /api/admin/matrix-appservice/setup/
Summary: Setup Matrix appservice registration
Description: Generates fresh appservice tokens (rotating any existing ones), enables the appservice, and returns registration YAML.
Request body: yes

### admin_matrix_appservice_status_retrieve
GET /api/admin/matrix-appservice/status/
Summary: Get Matrix appservice status
Description: Returns the current appservice configuration state.

### admin_matrix_diagnostics_retrieve
GET /api/admin/matrix/diagnostics/
Summary: Run Matrix connectivity diagnostics
Description: Performs live connectivity checks against the configured Matrix homeserver and returns results for each check.

### admin_matrix_livekit_overview_retrieve
GET /api/admin/matrix/livekit/overview/
Summary: Get LiveKit calls overview
Description: Point-in-time snapshot of active LiveKit rooms with participant/publisher totals. Staff only. Returns 503 when LiveKit credentials are not configured and 502 when LiveKit is unreachable or rejects the configured credentials.

### admin_matrix_livekit_participants_list
GET /api/admin/matrix/livekit/participants/
Summary: List participants in a LiveKit room
Description: Participants and their tracks for a single LiveKit room. Staff only. An unknown or empty room returns 200 with an empty list. Returns 503 when LiveKit credentials are not configured and 502 when LiveKit is unreachable or rejects the configured credentials.
Query parameters (1):
  - room (required) — LiveKit room name. A query parameter rather than a path segment because Element Call room names are base64 and routinely contain '/'.

### admin_matrix_reprovision
POST /api/admin/matrix/reprovision/
Summary: Reprovision all active Matrix rooms on a new homeserver
Description: Resets all active rooms to 'creating' state and re-queues them for provisioning. Also resets all user profiles. Staff only.

============================================================
## admin-announcements  (module: waldur_api_client.api.admin_announcements)
============================================================

### admin_announcements_list
GET /api/admin-announcements/
Query parameters (5):
  - description
  - field
  - is_active
  - o — Ordering
  - type

### admin_announcements_count
HEAD /api/admin-announcements/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - description
  - is_active
  - o — Ordering
  - type

### admin_announcements_create
POST /api/admin-announcements/
Request body: yes

### admin_announcements_retrieve
GET /api/admin-announcements/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### admin_announcements_update
PUT /api/admin-announcements/{uuid}/
Path parameters:
  - uuid
Request body: yes

### admin_announcements_partial_update
PATCH /api/admin-announcements/{uuid}/
Path parameters:
  - uuid
Request body: yes

### admin_announcements_destroy
DELETE /api/admin-announcements/{uuid}/
Path parameters:
  - uuid

============================================================
## affiliated-organizations  (module: waldur_api_client.api.affiliated_organizations)
============================================================

### affiliated_organizations_list
GET /api/affiliated-organizations/
Query parameters (9):
  - abbreviation — Abbreviation
  - code — Code
  - country — Country
  - default_for_customer — Limit to a customer's default affiliation list
  - field
  - name — Name
  - name_exact — Name (exact)
  - o — Which field to use when ordering the results.
  - query — Search

### affiliated_organizations_count
HEAD /api/affiliated-organizations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - abbreviation — Abbreviation
  - code — Code
  - country — Country
  - default_for_customer — Limit to a customer's default affiliation list
  - name — Name
  - name_exact — Name (exact)
  - o — Which field to use when ordering the results.
  - query — Search

### affiliated_organizations_create
POST /api/affiliated-organizations/
Request body: yes

### affiliated_organizations_report_list
GET /api/affiliated-organizations/report/
Summary: Get affiliated organizations report
Description: Staff-only report showing aggregated data for all affiliated organizations plus an unaffiliated row.
Query parameters (8):
  - abbreviation — Abbreviation
  - code — Code
  - country — Country
  - default_for_customer — Limit to a customer's default affiliation list
  - name — Name
  - name_exact — Name (exact)
  - o — Which field to use when ordering the results.
  - query — Search

### affiliated_organizations_report_count
HEAD /api/affiliated-organizations/report/
Summary: Get affiliated organizations report
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - abbreviation — Abbreviation
  - code — Code
  - country — Country
  - default_for_customer — Limit to a customer's default affiliation list
  - name — Name
  - name_exact — Name (exact)
  - o — Which field to use when ordering the results.
  - query — Search

### affiliated_organizations_retrieve
GET /api/affiliated-organizations/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### affiliated_organizations_update
PUT /api/affiliated-organizations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### affiliated_organizations_partial_update
PATCH /api/affiliated-organizations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### affiliated_organizations_destroy
DELETE /api/affiliated-organizations/{uuid}/
Path parameters:
  - uuid

### affiliated_organizations_stats_retrieve
GET /api/affiliated-organizations/{uuid}/stats/
Summary: Get affiliated organization statistics
Description: Returns permission-filtered statistics for this affiliated organization.
Path parameters:
  - uuid

============================================================
## anonymous-chat-feedbacks  (module: waldur_api_client.api.anonymous_chat_feedbacks)
============================================================

### anonymous_chat_feedbacks_list
GET /api/anonymous-chat-feedbacks/
Query parameters (6):
  - category
  - has_comment
  - o — Ordering
  - score
  - submitted_from
  - submitted_to

### anonymous_chat_feedbacks_retrieve
GET /api/anonymous-chat-feedbacks/{interaction_uuid}/
Path parameters:
  - interaction_uuid

============================================================
## anonymous-chat-interactions  (module: waldur_api_client.api.anonymous_chat_interactions)
============================================================

### anonymous_chat_interactions_list
GET /api/anonymous-chat-interactions/
Query parameters (8):
  - created_from
  - created_to
  - has_negative_feedback
  - is_flagged
  - o — Ordering
  - session_id
  - severity
  - user_slug

### anonymous_chat_interactions_budget_retrieve
GET /api/anonymous-chat-interactions/budget/
Summary: Today's global tenant budget snapshot
Description: Returns the site-wide token + request usage accumulated since 00:00 UTC today and the configured daily caps. Powers the budget gauges card on the staff analytics dashboard.

### anonymous_chat_interactions_by_session_list
GET /api/anonymous-chat-interactions/by-session/{session_id}/
Summary: Full transcript for one anonymous session
Description: Returns the ordered list of interactions belonging to the given ``session_id``. Use this to read a conversation as a transcript.
Path parameters:
  - session_id
Query parameters (8):
  - created_from
  - created_to
  - has_negative_feedback
  - is_flagged
  - o — Ordering
  - session_id
  - severity
  - user_slug

### anonymous_chat_interactions_by_user_aggregate
GET /api/anonymous-chat-interactions/by-user/
Summary: Aggregate user list (no slug)
Description: Returns one row per user_slug with aggregate counters. Powers the staff Users page in the admin analytics.
Query parameters (8):
  - created_from
  - created_to
  - has_negative_feedback
  - is_flagged
  - o — Ordering
  - session_id
  - severity
  - user_slug

### anonymous_chat_interactions_by_user_list
GET /api/anonymous-chat-interactions/by-user/{user_slug}/
Summary: All sessions for one pseudonymous user
Description: Returns interactions sharing a ``user_slug`` (Scrypt of originating IP) — across however many sessions that anon user opened, ordered chronologically.
Path parameters:
  - user_slug
Query parameters (8):
  - created_from
  - created_to
  - has_negative_feedback
  - is_flagged
  - o — Ordering
  - session_id
  - severity
  - user_slug

### anonymous_chat_interactions_kpi_retrieve
GET /api/anonymous-chat-interactions/kpi/
Summary: Aggregate KPI roll-up
Description: Returns aggregate counters and rates for the anonymous chat flow. Filters are honoured (date range etc.) so the same parameters work as on the list endpoint.

### anonymous_chat_interactions_retrieve
GET /api/anonymous-chat-interactions/{uuid}/
Path parameters:
  - uuid

============================================================
## api-auth  (module: waldur_api_client.api.api_auth)
============================================================

### api_auth_eduteams_complete_retrieve
GET /api-auth/eduteams/complete/
Query parameters (2):
  - code
  - state

### api_auth_eduteams_init_retrieve
GET /api-auth/eduteams/init/
Summary: Redirect user to OIDC authorization endpoint

### api_auth_keycloak_complete_retrieve
GET /api-auth/keycloak/complete/
Query parameters (2):
  - code
  - state

### api_auth_keycloak_init_retrieve
GET /api-auth/keycloak/init/
Summary: Redirect user to OIDC authorization endpoint

### api_auth_logout
POST /api-auth/logout/
Summary: Log out
Description: Logs out the current user by deleting their authentication token. If single logout (SLO) is supported for the current authentication method (e.g., SAML2 or OIDC), this endpoint may return a logout URL to which the user should be redirected to complete the logout process on the identity provider s...

### api_auth_password
POST /api-auth/password/
Summary: Obtain authentication token
Description: Authenticates a user with username and password and returns an authentication token.
Request body: yes

### api_auth_saml2_login
POST /api-auth/saml2/login/
Request body: yes

### api_auth_saml2_login_complete
POST /api-auth/saml2/login/complete/
Request body: yes

### api_auth_saml2_logout_retrieve
GET /api-auth/saml2/logout/

### api_auth_saml2_logout_complete_retrieve
GET /api-auth/saml2/logout/complete/
Summary: For IdPs which send GET requests

### api_auth_saml2_logout_complete
POST /api-auth/saml2/logout/complete/
Summary: For IdPs which send POST requests
Request body: yes

### api_auth_saml2_providers_list
GET /api-auth/saml2/providers/
Query parameters (1):
  - name

### api_auth_tara_complete_retrieve
GET /api-auth/tara/complete/
Query parameters (2):
  - code
  - state

### api_auth_tara_init_retrieve
GET /api-auth/tara/init/
Summary: Redirect user to OIDC authorization endpoint

### api_auth_token_exchange
POST /api-auth/token-exchange/
Summary: Exchange code for token
Description: Exchanges a short-lived one-time code for an authentication token.
Request body: yes

============================================================
## assignment-batches  (module: waldur_api_client.api.assignment_batches)
============================================================

### assignment_batches_list
GET /api/assignment-batches/
Query parameters (8):
  - call_uuid
  - o — Ordering
  - reviewer_pool_entry_uuid
  - reviewer_uuid
  - sent_after
  - sent_before
  - source
  - status

### assignment_batches_count
HEAD /api/assignment-batches/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - call_uuid
  - o — Ordering
  - reviewer_pool_entry_uuid
  - reviewer_uuid
  - sent_after
  - sent_before
  - source
  - status

### assignment_batches_create
POST /api/assignment-batches/
Request body: yes

### assignment_batches_retrieve
GET /api/assignment-batches/{uuid}/
Path parameters:
  - uuid

### assignment_batches_update
PUT /api/assignment-batches/{uuid}/
Path parameters:
  - uuid
Request body: yes

### assignment_batches_partial_update
PATCH /api/assignment-batches/{uuid}/
Path parameters:
  - uuid
Request body: yes

### assignment_batches_destroy
DELETE /api/assignment-batches/{uuid}/
Path parameters:
  - uuid

### assignment_batches_cancel
POST /api/assignment-batches/{uuid}/cancel/
Summary: Cancel this assignment batch
Description: Cancel this assignment batch.
Path parameters:
  - uuid

### assignment_batches_extend_deadline
POST /api/assignment-batches/{uuid}/extend-deadline/
Summary: Extend or modify the expiration date for an assignment batch
Description: Extend or modify the expiration date for an assignment batch. Can reactivate expired batches by setting a future deadline.
Path parameters:
  - uuid
Request body: yes

### assignment_batches_send
POST /api/assignment-batches/{uuid}/send/
Summary: Send this assignment batch invitation to the reviewer
Description: Send this assignment batch invitation to the reviewer.
Path parameters:
  - uuid
Request body: yes

============================================================
## assignment-items  (module: waldur_api_client.api.assignment_items)
============================================================

### assignment_items_list
GET /api/assignment-items/
Query parameters (8):
  - batch_uuid
  - call_uuid
  - has_coi
  - min_affinity_score
  - o — Ordering
  - proposal_uuid
  - reviewer_uuid
  - status

### assignment_items_count
HEAD /api/assignment-items/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - batch_uuid
  - call_uuid
  - has_coi
  - min_affinity_score
  - o — Ordering
  - proposal_uuid
  - reviewer_uuid
  - status

### assignment_items_create
POST /api/assignment-items/
Request body: yes

### assignment_items_retrieve
GET /api/assignment-items/{uuid}/
Path parameters:
  - uuid

### assignment_items_update
PUT /api/assignment-items/{uuid}/
Path parameters:
  - uuid
Request body: yes

### assignment_items_partial_update
PATCH /api/assignment-items/{uuid}/
Path parameters:
  - uuid
Request body: yes

### assignment_items_destroy
DELETE /api/assignment-items/{uuid}/
Path parameters:
  - uuid

### assignment_items_accept
POST /api/assignment-items/{uuid}/accept/
Summary: Accept this assignment item
Description: Accept this assignment item. Creates a Review record.
Path parameters:
  - uuid

### assignment_items_decline
POST /api/assignment-items/{uuid}/decline/
Summary: Decline this assignment item
Description: Decline this assignment item.
Path parameters:
  - uuid
Request body: yes

### assignment_items_force_unblock
POST /api/assignment-items/{uuid}/force-unblock/
Summary: Force-unblock a COI-blocked assignment item (manager override)
Description: Force-unblock a COI-blocked assignment item (manager override).
Path parameters:
  - uuid
Request body: yes

### assignment_items_reassign
POST /api/assignment-items/{uuid}/reassign/
Summary: Reassign this item to a different reviewer
Description: Reassign this item to a different reviewer.
Path parameters:
  - uuid
Request body: yes

### assignment_items_suggest_alternatives_retrieve
GET /api/assignment-items/{uuid}/suggest_alternatives/
Summary: Suggest alternative reviewers for a declined assignment
Description: Suggest alternative reviewers for a declined assignment.
Path parameters:
  - uuid

============================================================
## auth-tokens  (module: waldur_api_client.api.auth_tokens)
============================================================

### auth_tokens_list
GET /api/auth-tokens/

### auth_tokens_count
HEAD /api/auth-tokens/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### auth_tokens_retrieve
GET /api/auth-tokens/{user_id}/
Path parameters:
  - user_id

### auth_tokens_destroy
DELETE /api/auth-tokens/{user_id}/
Path parameters:
  - user_id

============================================================
## auth-valimo  (module: waldur_api_client.api.auth_valimo)
============================================================

### auth_valimo_create
POST /api/auth-valimo/
Request body: yes

### auth_valimo_result
POST /api/auth-valimo/result/
Summary: To get PKI login status and details - issue post request against /api/auth-valimo/result/
        with uuid in parameters
Description: To get PKI login status and details - issue post request against /api/auth-valimo/result/
        with uuid in parameters.

        Possible states:
         - Scheduled - login process is scheduled
         - Processing - login is in progress
         - OK - login was successful. Response will c...
Request body: yes

============================================================
## autoprovisioning-rules  (module: waldur_api_client.api.autoprovisioning_rules)
============================================================

### autoprovisioning_rules_list
GET /api/autoprovisioning-rules/
Summary: Manage autoprovisioning rules
Description: Manage autoprovisioning rules.

### autoprovisioning_rules_count
HEAD /api/autoprovisioning-rules/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### autoprovisioning_rules_create
POST /api/autoprovisioning-rules/
Summary: Manage autoprovisioning rules
Description: Manage autoprovisioning rules.
Request body: yes

### autoprovisioning_rules_retrieve
GET /api/autoprovisioning-rules/{uuid}/
Summary: Manage autoprovisioning rules
Description: Manage autoprovisioning rules.
Path parameters:
  - uuid

### autoprovisioning_rules_update
PUT /api/autoprovisioning-rules/{uuid}/
Summary: Manage autoprovisioning rules
Description: Manage autoprovisioning rules.
Path parameters:
  - uuid
Request body: yes

### autoprovisioning_rules_partial_update
PATCH /api/autoprovisioning-rules/{uuid}/
Summary: Manage autoprovisioning rules
Description: Manage autoprovisioning rules.
Path parameters:
  - uuid
Request body: yes

### autoprovisioning_rules_destroy
DELETE /api/autoprovisioning-rules/{uuid}/
Summary: Manage autoprovisioning rules
Description: Manage autoprovisioning rules.
Path parameters:
  - uuid

### autoprovisioning_rules_test_match
POST /api/autoprovisioning-rules/{uuid}/test-match/
Summary: Dry-run rule evaluation against a target user.
Description: Evaluate this rule against the given user without provisioning. Returns per-filter outcomes, the customer-lookup verdict (when the rule uses use_user_organization_as_customer_name) and a top-line would_provision flag together with a human-readable block_reason.
Path parameters:
  - uuid
Request body: yes

============================================================
## aws-images  (module: waldur_api_client.api.aws_images)
============================================================

### aws_images_list
GET /api/aws-images/
Query parameters (3):
  - name — Name
  - name_exact — Name (exact)
  - region

### aws_images_count
HEAD /api/aws-images/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - name — Name
  - name_exact — Name (exact)
  - region

### aws_images_retrieve
GET /api/aws-images/{uuid}/
Path parameters:
  - uuid

============================================================
## aws-instances  (module: waldur_api_client.api.aws_instances)
============================================================

### aws_instances_list
GET /api/aws-instances/
Query parameters (18):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### aws_instances_count
HEAD /api/aws-instances/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (17):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### aws_instances_create
POST /api/aws-instances/
Request body: yes

### aws_instances_retrieve
GET /api/aws-instances/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### aws_instances_update
PUT /api/aws-instances/{uuid}/
Path parameters:
  - uuid
Request body: yes

### aws_instances_partial_update
PATCH /api/aws-instances/{uuid}/
Path parameters:
  - uuid
Request body: yes

### aws_instances_destroy
DELETE /api/aws-instances/{uuid}/
Path parameters:
  - uuid

### aws_instances_pull
POST /api/aws-instances/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### aws_instances_resize
POST /api/aws-instances/{uuid}/resize/
Path parameters:
  - uuid
Request body: yes

### aws_instances_restart
POST /api/aws-instances/{uuid}/restart/
Path parameters:
  - uuid

### aws_instances_set_erred
POST /api/aws-instances/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### aws_instances_set_ok
POST /api/aws-instances/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### aws_instances_start
POST /api/aws-instances/{uuid}/start/
Path parameters:
  - uuid

### aws_instances_stop
POST /api/aws-instances/{uuid}/stop/
Path parameters:
  - uuid

### aws_instances_unlink
POST /api/aws-instances/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## aws-regions  (module: waldur_api_client.api.aws_regions)
============================================================

### aws_regions_list
GET /api/aws-regions/
Query parameters (2):
  - name — Name
  - name_exact — Name (exact)

### aws_regions_count
HEAD /api/aws-regions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - name — Name
  - name_exact — Name (exact)

### aws_regions_retrieve
GET /api/aws-regions/{uuid}/
Path parameters:
  - uuid

============================================================
## aws-sizes  (module: waldur_api_client.api.aws_sizes)
============================================================

### aws_sizes_list
GET /api/aws-sizes/
Query parameters (3):
  - name — Name
  - name_exact — Name (exact)
  - region

### aws_sizes_count
HEAD /api/aws-sizes/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - name — Name
  - name_exact — Name (exact)
  - region

### aws_sizes_retrieve
GET /api/aws-sizes/{uuid}/
Path parameters:
  - uuid

============================================================
## aws-volumes  (module: waldur_api_client.api.aws_volumes)
============================================================

### aws_volumes_list
GET /api/aws-volumes/
Query parameters (1):
  - field

### aws_volumes_count
HEAD /api/aws-volumes/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### aws_volumes_create
POST /api/aws-volumes/
Request body: yes

### aws_volumes_retrieve
GET /api/aws-volumes/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### aws_volumes_update
PUT /api/aws-volumes/{uuid}/
Path parameters:
  - uuid
Request body: yes

### aws_volumes_partial_update
PATCH /api/aws-volumes/{uuid}/
Path parameters:
  - uuid

### aws_volumes_destroy
DELETE /api/aws-volumes/{uuid}/
Path parameters:
  - uuid

### aws_volumes_attach
POST /api/aws-volumes/{uuid}/attach/
Path parameters:
  - uuid
Request body: yes

### aws_volumes_detach
POST /api/aws-volumes/{uuid}/detach/
Path parameters:
  - uuid

### aws_volumes_pull
POST /api/aws-volumes/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### aws_volumes_set_erred
POST /api/aws-volumes/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### aws_volumes_set_ok
POST /api/aws-volumes/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### aws_volumes_unlink
POST /api/aws-volumes/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## azure-images  (module: waldur_api_client.api.azure_images)
============================================================

### azure_images_list
GET /api/azure-images/
Query parameters (6):
  - location
  - location_uuid
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### azure_images_count
HEAD /api/azure-images/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - location
  - location_uuid
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### azure_images_retrieve
GET /api/azure-images/{uuid}/
Path parameters:
  - uuid

============================================================
## azure-locations  (module: waldur_api_client.api.azure_locations)
============================================================

### azure_locations_list
GET /api/azure-locations/
Query parameters (5):
  - has_sizes
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### azure_locations_count
HEAD /api/azure-locations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - has_sizes
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### azure_locations_retrieve
GET /api/azure-locations/{uuid}/
Path parameters:
  - uuid

============================================================
## azure-public-ips  (module: waldur_api_client.api.azure_public_ips)
============================================================

### azure_public_ips_list
GET /api/azure-public-ips/
Query parameters (20):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - resource_group
  - resource_group_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### azure_public_ips_count
HEAD /api/azure-public-ips/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (19):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - resource_group
  - resource_group_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### azure_public_ips_create
POST /api/azure-public-ips/
Request body: yes

### azure_public_ips_retrieve
GET /api/azure-public-ips/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### azure_public_ips_update
PUT /api/azure-public-ips/{uuid}/
Path parameters:
  - uuid
Request body: yes

### azure_public_ips_partial_update
PATCH /api/azure-public-ips/{uuid}/
Path parameters:
  - uuid
Request body: yes

### azure_public_ips_destroy
DELETE /api/azure-public-ips/{uuid}/
Path parameters:
  - uuid

### azure_public_ips_pull
POST /api/azure-public-ips/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### azure_public_ips_set_erred
POST /api/azure-public-ips/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### azure_public_ips_set_ok
POST /api/azure-public-ips/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### azure_public_ips_unlink
POST /api/azure-public-ips/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## azure-resource-groups  (module: waldur_api_client.api.azure_resource_groups)
============================================================

### azure_resource_groups_list
GET /api/azure-resource-groups/
Query parameters (1):
  - field

### azure_resource_groups_count
HEAD /api/azure-resource-groups/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### azure_resource_groups_retrieve
GET /api/azure-resource-groups/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

============================================================
## azure-sizes  (module: waldur_api_client.api.azure_sizes)
============================================================

### azure_sizes_list
GET /api/azure-sizes/
Query parameters (7):
  - location
  - location_uuid
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - zone

### azure_sizes_count
HEAD /api/azure-sizes/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (7):
  - location
  - location_uuid
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - zone

### azure_sizes_retrieve
GET /api/azure-sizes/{uuid}/
Path parameters:
  - uuid

============================================================
## azure-sql-databases  (module: waldur_api_client.api.azure_sql_databases)
============================================================

### azure_sql_databases_list
GET /api/azure-sql-databases/
Query parameters (22):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - resource_group
  - resource_group_uuid
  - server
  - server_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### azure_sql_databases_count
HEAD /api/azure-sql-databases/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (21):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - resource_group
  - resource_group_uuid
  - server
  - server_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### azure_sql_databases_create
POST /api/azure-sql-databases/
Request body: yes

### azure_sql_databases_retrieve
GET /api/azure-sql-databases/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### azure_sql_databases_update
PUT /api/azure-sql-databases/{uuid}/
Path parameters:
  - uuid
Request body: yes

### azure_sql_databases_partial_update
PATCH /api/azure-sql-databases/{uuid}/
Path parameters:
  - uuid
Request body: yes

### azure_sql_databases_destroy
DELETE /api/azure-sql-databases/{uuid}/
Path parameters:
  - uuid

### azure_sql_databases_pull
POST /api/azure-sql-databases/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### azure_sql_databases_set_erred
POST /api/azure-sql-databases/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### azure_sql_databases_set_ok
POST /api/azure-sql-databases/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### azure_sql_databases_unlink
POST /api/azure-sql-databases/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## azure-sql-servers  (module: waldur_api_client.api.azure_sql_servers)
============================================================

### azure_sql_servers_list
GET /api/azure-sql-servers/
Query parameters (20):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - resource_group
  - resource_group_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### azure_sql_servers_count
HEAD /api/azure-sql-servers/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (19):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - resource_group
  - resource_group_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### azure_sql_servers_create
POST /api/azure-sql-servers/
Request body: yes

### azure_sql_servers_retrieve
GET /api/azure-sql-servers/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### azure_sql_servers_update
PUT /api/azure-sql-servers/{uuid}/
Path parameters:
  - uuid
Request body: yes

### azure_sql_servers_partial_update
PATCH /api/azure-sql-servers/{uuid}/
Path parameters:
  - uuid
Request body: yes

### azure_sql_servers_destroy
DELETE /api/azure-sql-servers/{uuid}/
Path parameters:
  - uuid

### azure_sql_servers_create_database
POST /api/azure-sql-servers/{uuid}/create_database/
Path parameters:
  - uuid
Request body: yes

### azure_sql_servers_pull
POST /api/azure-sql-servers/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### azure_sql_servers_set_erred
POST /api/azure-sql-servers/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### azure_sql_servers_set_ok
POST /api/azure-sql-servers/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### azure_sql_servers_unlink
POST /api/azure-sql-servers/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## azure-virtualmachines  (module: waldur_api_client.api.azure_virtualmachines)
============================================================

### azure_virtualmachines_list
GET /api/azure-virtualmachines/
Query parameters (20):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - resource_group
  - resource_group_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### azure_virtualmachines_count
HEAD /api/azure-virtualmachines/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (19):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - resource_group
  - resource_group_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### azure_virtualmachines_create
POST /api/azure-virtualmachines/
Request body: yes

### azure_virtualmachines_retrieve
GET /api/azure-virtualmachines/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### azure_virtualmachines_update
PUT /api/azure-virtualmachines/{uuid}/
Path parameters:
  - uuid
Request body: yes

### azure_virtualmachines_partial_update
PATCH /api/azure-virtualmachines/{uuid}/
Path parameters:
  - uuid
Request body: yes

### azure_virtualmachines_destroy
DELETE /api/azure-virtualmachines/{uuid}/
Path parameters:
  - uuid

### azure_virtualmachines_pull
POST /api/azure-virtualmachines/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### azure_virtualmachines_restart
POST /api/azure-virtualmachines/{uuid}/restart/
Path parameters:
  - uuid

### azure_virtualmachines_set_erred
POST /api/azure-virtualmachines/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### azure_virtualmachines_set_ok
POST /api/azure-virtualmachines/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### azure_virtualmachines_start
POST /api/azure-virtualmachines/{uuid}/start/
Path parameters:
  - uuid

### azure_virtualmachines_stop
POST /api/azure-virtualmachines/{uuid}/stop/
Path parameters:
  - uuid

### azure_virtualmachines_unlink
POST /api/azure-virtualmachines/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## backend-resource-requests  (module: waldur_api_client.api.backend_resource_requests)
============================================================

### backend_resource_requests_list
GET /api/backend-resource-requests/
Summary: List backend resource requests
Description: Returns a paginated list of requests for backend resources.
Query parameters (9):
  - created — Created after
  - created_before — Created before
  - finished — Modified after
  - modified — Modified after
  - modified_before — Modified before
  - o — Ordering
  - offering_uuid — Offering UUID
  - started — Created after
  - state — Backend resource request state

### backend_resource_requests_count
HEAD /api/backend-resource-requests/
Summary: List backend resource requests
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - created — Created after
  - created_before — Created before
  - finished — Modified after
  - modified — Modified after
  - modified_before — Modified before
  - o — Ordering
  - offering_uuid — Offering UUID
  - started — Created after
  - state — Backend resource request state

### backend_resource_requests_create
POST /api/backend-resource-requests/
Summary: Create a backend resource request
Description: Creates a new request to fetch a list of importable resources from a backend. This is typically used by staff to trigger a site agent to report available resources.
Request body: yes

### backend_resource_requests_retrieve
GET /api/backend-resource-requests/{uuid}/
Summary: Retrieve a backend resource request
Description: Returns the details of a specific backend resource request.
Path parameters:
  - uuid

### backend_resource_requests_set_done
POST /api/backend-resource-requests/{uuid}/set_done/
Summary: Mark a request as done
Description: Transitions the request state from 'Processing' to 'Done'. This is used by a site agent to signal that it has successfully reported all available resources.
Path parameters:
  - uuid

### backend_resource_requests_set_erred
POST /api/backend-resource-requests/{uuid}/set_erred/
Summary: Mark a request as erred
Description: Transitions the request state to 'Erred'. This is used by a site agent to report a failure during the resource fetching process. An error message and traceback should be provided.
Path parameters:
  - uuid
Request body: yes

### backend_resource_requests_start_processing
POST /api/backend-resource-requests/{uuid}/start_processing/
Summary: Start processing a request
Description: Transitions the request state from 'Sent' to 'Processing'. This is used by a site agent to acknowledge that it has started fetching the resource list.
Path parameters:
  - uuid

============================================================
## backend-resources  (module: waldur_api_client.api.backend_resources)
============================================================

### backend_resources_list
GET /api/backend-resources/
Summary: List backend resources
Description: Returns a paginated list of backend resources that are available for import. This endpoint is typically used by site agents to see which resources they have reported.
Query parameters (10):
  - backend_id — Backend ID
  - created — Created after
  - created_before — Created before
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_uuid — Offering UUID
  - project_uuid — Project UUID

### backend_resources_count
HEAD /api/backend-resources/
Summary: List backend resources
Description: Get number of items in the collection matching the request parameters.
Query parameters (10):
  - backend_id — Backend ID
  - created — Created after
  - created_before — Created before
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_uuid — Offering UUID
  - project_uuid — Project UUID

### backend_resources_create
POST /api/backend-resources/
Summary: Create a backend resource
Description: Creates a new backend resource record. This is typically done by a site agent to report a resource that is available for import into the marketplace.
Request body: yes

### backend_resources_retrieve
GET /api/backend-resources/{uuid}/
Summary: Retrieve a backend resource
Description: Returns the details of a specific backend resource.
Path parameters:
  - uuid

### backend_resources_destroy
DELETE /api/backend-resources/{uuid}/
Summary: Delete a backend resource
Description: Deletes a backend resource record. This is typically done when the resource is no longer available for import.
Path parameters:
  - uuid

### backend_resources_import_resource
POST /api/backend-resources/{uuid}/import_resource/
Summary: Import a backend resource (staff only)
Description: Converts a backend resource into a full marketplace resource. This action is restricted to staff users.
        Upon successful import, the original backend resource record is deleted. A fake order in the 'done'
        state is created to represent the import event.
Path parameters:
  - uuid
Request body: yes

============================================================
## billing-total-cost  (module: waldur_api_client.api.billing_total_cost)
============================================================

### billing_total_cost_retrieve
GET /api/billing-total-cost/
Query parameters (5):
  - accounting_is_running
  - customer_uuid
  - month
  - name
  - year

============================================================
## booking-offerings  (module: waldur_api_client.api.booking_offerings)
============================================================

### booking_offerings_list
GET /api/booking-offerings/
Query parameters (1):
  - field

### booking_offerings_count
HEAD /api/booking-offerings/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### booking_offerings_retrieve
GET /api/booking-offerings/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### booking_offerings_google_calendar_sync
POST /api/booking-offerings/{uuid}/google_calendar_sync/
Path parameters:
  - uuid

### booking_offerings_share_google_calendar
POST /api/booking-offerings/{uuid}/share_google_calendar/
Path parameters:
  - uuid

### booking_offerings_unshare_google_calendar
POST /api/booking-offerings/{uuid}/unshare_google_calendar/
Path parameters:
  - uuid

============================================================
## booking-resources  (module: waldur_api_client.api.booking_resources)
============================================================

### booking_resources_list
GET /api/booking-resources/
Query parameters (47):
  - backend_id — Backend ID
  - category_uuid — Category UUID
  - component_count — Filter by exact number of components
  - connected_customer_uuid
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - downscaled — Downscaled
  - field
  - flavor_name — Flavor name
  - has_terminate_date — Has termination date
  - image_name — Image name
  - is_attached — Filter by attached state
  - lexis_links_supported — LEXIS links supported
  - limit_based — Filter by limit-based offerings
  - limit_component_count — Filter by exact number of limit-based components
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering
  - offering_billable — Offering billable
  - offering_shared — Offering shared
  - offering_slug — Multiple values may be separated by commas.
  - offering_type — Offering type
  - offering_uuid — Multiple values may be separated by commas.
  - only_limit_based — Filter resources with only limit-based components
  - only_usage_based — Filter resources with only usage-based components
  - order_state — Order state
  - parent_offering_uuid
  - paused — Paused
  - plan_uuid — Plan UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - query — Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
  - resource_attributes — Resource attributes (JSON)
  - restrict_member_access — Restrict member access
  - runtime_state — Runtime state
  - service_manager_uuid — Service manager UUID
  - slug — Slug
  - state — Resource state
  - usage_based — Filter by usage-based offerings
  - visible_to_providers — Include only resources visible to service providers
  - visible_to_username — Visible to username

### booking_resources_count
HEAD /api/booking-resources/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (46):
  - backend_id — Backend ID
  - category_uuid — Category UUID
  - component_count — Filter by exact number of components
  - connected_customer_uuid
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - downscaled — Downscaled
  - flavor_name — Flavor name
  - has_terminate_date — Has termination date
  - image_name — Image name
  - is_attached — Filter by attached state
  - lexis_links_supported — LEXIS links supported
  - limit_based — Filter by limit-based offerings
  - limit_component_count — Filter by exact number of limit-based components
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering
  - offering_billable — Offering billable
  - offering_shared — Offering shared
  - offering_slug — Multiple values may be separated by commas.
  - offering_type — Offering type
  - offering_uuid — Multiple values may be separated by commas.
  - only_limit_based — Filter resources with only limit-based components
  - only_usage_based — Filter resources with only usage-based components
  - order_state — Order state
  - parent_offering_uuid
  - paused — Paused
  - plan_uuid — Plan UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - query — Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
  - resource_attributes — Resource attributes (JSON)
  - restrict_member_access — Restrict member access
  - runtime_state — Runtime state
  - service_manager_uuid — Service manager UUID
  - slug — Slug
  - state — Resource state
  - usage_based — Filter by usage-based offerings
  - visible_to_providers — Include only resources visible to service providers
  - visible_to_username — Visible to username

### booking_resources_retrieve
GET /api/booking-resources/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### booking_resources_accept
POST /api/booking-resources/{uuid}/accept/
Path parameters:
  - uuid

### booking_resources_reject
POST /api/booking-resources/{uuid}/reject/
Path parameters:
  - uuid

============================================================
## broadcast-message-templates  (module: waldur_api_client.api.broadcast_message_templates)
============================================================

### broadcast_message_templates_list
GET /api/broadcast-message-templates/
Query parameters (1):
  - name

### broadcast_message_templates_count
HEAD /api/broadcast-message-templates/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - name

### broadcast_message_templates_create
POST /api/broadcast-message-templates/
Request body: yes

### broadcast_message_templates_retrieve
GET /api/broadcast-message-templates/{uuid}/
Path parameters:
  - uuid

### broadcast_message_templates_update
PUT /api/broadcast-message-templates/{uuid}/
Path parameters:
  - uuid
Request body: yes

### broadcast_message_templates_partial_update
PATCH /api/broadcast-message-templates/{uuid}/
Path parameters:
  - uuid
Request body: yes

### broadcast_message_templates_destroy
DELETE /api/broadcast-message-templates/{uuid}/
Path parameters:
  - uuid

============================================================
## broadcast-messages  (module: waldur_api_client.api.broadcast_messages)
============================================================

### broadcast_messages_list
GET /api/broadcast-messages/
Query parameters (4):
  - field
  - o — Ordering
  - state
  - subject

### broadcast_messages_count
HEAD /api/broadcast-messages/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - o — Ordering
  - state
  - subject

### broadcast_messages_create
POST /api/broadcast-messages/
Request body: yes

### broadcast_messages_recipients_retrieve
GET /api/broadcast-messages/recipients/

### broadcast_messages_recipients_count
HEAD /api/broadcast-messages/recipients/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### broadcast_messages_retrieve
GET /api/broadcast-messages/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### broadcast_messages_update
PUT /api/broadcast-messages/{uuid}/
Path parameters:
  - uuid
Request body: yes

### broadcast_messages_partial_update
PATCH /api/broadcast-messages/{uuid}/
Path parameters:
  - uuid
Request body: yes

### broadcast_messages_destroy
DELETE /api/broadcast-messages/{uuid}/
Path parameters:
  - uuid

### broadcast_messages_schedule
POST /api/broadcast-messages/{uuid}/schedule/
Path parameters:
  - uuid

### broadcast_messages_send
POST /api/broadcast-messages/{uuid}/send/
Path parameters:
  - uuid

============================================================
## call-assignment-configurations  (module: waldur_api_client.api.call_assignment_configurations)
============================================================

### call_assignment_configurations_list
GET /api/call-assignment-configurations/

### call_assignment_configurations_count
HEAD /api/call-assignment-configurations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### call_assignment_configurations_create
POST /api/call-assignment-configurations/
Request body: yes

### call_assignment_configurations_retrieve
GET /api/call-assignment-configurations/{uuid}/
Path parameters:
  - uuid

### call_assignment_configurations_update
PUT /api/call-assignment-configurations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### call_assignment_configurations_partial_update
PATCH /api/call-assignment-configurations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### call_assignment_configurations_destroy
DELETE /api/call-assignment-configurations/{uuid}/
Path parameters:
  - uuid

============================================================
## call-managing-organisations  (module: waldur_api_client.api.call_managing_organisations)
============================================================

### call_managing_organisations_list
GET /api/call-managing-organisations/
Query parameters (4):
  - customer
  - customer_keyword
  - customer_uuid
  - o — Ordering

### call_managing_organisations_count
HEAD /api/call-managing-organisations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - customer
  - customer_keyword
  - customer_uuid
  - o — Ordering

### call_managing_organisations_create
POST /api/call-managing-organisations/
Request body: yes

### call_managing_organisations_global_stats_performance_list
GET /api/call-managing-organisations/global_stats_performance/
Summary: Get call performance statistics across all calls
Description: Get call performance statistics across all calls.
Query parameters (4):
  - customer
  - customer_keyword
  - customer_uuid
  - o — Ordering

### call_managing_organisations_global_stats_performance_count
HEAD /api/call-managing-organisations/global_stats_performance/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - customer
  - customer_keyword
  - customer_uuid
  - o — Ordering

### call_managing_organisations_global_stats_resource_demand_list
GET /api/call-managing-organisations/global_stats_resource_demand/
Summary: Get resource demand statistics across all calls and offerings
Description: Get resource demand statistics across all calls and offerings.
Query parameters (4):
  - customer
  - customer_keyword
  - customer_uuid
  - o — Ordering

### call_managing_organisations_global_stats_resource_demand_count
HEAD /api/call-managing-organisations/global_stats_resource_demand/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - customer
  - customer_keyword
  - customer_uuid
  - o — Ordering

### call_managing_organisations_global_stats_review_progress_list
GET /api/call-managing-organisations/global_stats_review_progress/
Summary: Get review progress statistics across all reviewers
Description: Get review progress statistics across all reviewers.
Query parameters (4):
  - customer
  - customer_keyword
  - customer_uuid
  - o — Ordering

### call_managing_organisations_global_stats_review_progress_count
HEAD /api/call-managing-organisations/global_stats_review_progress/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - customer
  - customer_keyword
  - customer_uuid
  - o — Ordering

### call_managing_organisations_retrieve
GET /api/call-managing-organisations/{uuid}/
Path parameters:
  - uuid

### call_managing_organisations_update
PUT /api/call-managing-organisations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### call_managing_organisations_partial_update
PATCH /api/call-managing-organisations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### call_managing_organisations_destroy
DELETE /api/call-managing-organisations/{uuid}/
Path parameters:
  - uuid

### call_managing_organisations_add_user
POST /api/call-managing-organisations/{uuid}/add_user/
Summary: Grant a role to a user
Description: Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
Path parameters:
  - uuid
Request body: yes

### call_managing_organisations_delete_user
POST /api/call-managing-organisations/{uuid}/delete_user/
Summary: Revoke a role from a user
Description: Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
Path parameters:
  - uuid
Request body: yes

### call_managing_organisations_list_users_list
GET /api/call-managing-organisations/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### call_managing_organisations_list_users_count
HEAD /api/call-managing-organisations/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### call_managing_organisations_stats_retrieve
GET /api/call-managing-organisations/{uuid}/stats/
Summary: Return statistics for call managing organisation
Description: Return statistics for call managing organisation.
Path parameters:
  - uuid

### call_managing_organisations_update_user
POST /api/call-managing-organisations/{uuid}/update_user/
Summary: Update a user's role expiration
Description: Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
Path parameters:
  - uuid
Request body: yes

============================================================
## call-proposal-project-role-mappings  (module: waldur_api_client.api.call_proposal_project_role_mappings)
============================================================

### call_proposal_project_role_mappings_list
GET /api/call-proposal-project-role-mappings/
Query parameters (1):
  - call_uuid

### call_proposal_project_role_mappings_count
HEAD /api/call-proposal-project-role-mappings/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - call_uuid

### call_proposal_project_role_mappings_create
POST /api/call-proposal-project-role-mappings/
Request body: yes

### call_proposal_project_role_mappings_retrieve
GET /api/call-proposal-project-role-mappings/{uuid}/
Path parameters:
  - uuid

### call_proposal_project_role_mappings_update
PUT /api/call-proposal-project-role-mappings/{uuid}/
Path parameters:
  - uuid
Request body: yes

### call_proposal_project_role_mappings_partial_update
PATCH /api/call-proposal-project-role-mappings/{uuid}/
Path parameters:
  - uuid
Request body: yes

### call_proposal_project_role_mappings_destroy
DELETE /api/call-proposal-project-role-mappings/{uuid}/
Path parameters:
  - uuid

============================================================
## call-reviewer-pools  (module: waldur_api_client.api.call_reviewer_pools)
============================================================

### call_reviewer_pools_list
GET /api/call-reviewer-pools/
Query parameters (5):
  - call_uuid
  - invitation_status
  - my_invitations
  - o — Ordering
  - reviewer_uuid

### call_reviewer_pools_count
HEAD /api/call-reviewer-pools/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - call_uuid
  - invitation_status
  - my_invitations
  - o — Ordering
  - reviewer_uuid

### call_reviewer_pools_retrieve
GET /api/call-reviewer-pools/{uuid}/
Path parameters:
  - uuid

### call_reviewer_pools_partial_update
PATCH /api/call-reviewer-pools/{uuid}/
Path parameters:
  - uuid
Request body: yes

### call_reviewer_pools_accept
POST /api/call-reviewer-pools/{uuid}/accept/
Summary: Accept a pool invitation (authenticated users only)
Description: Accept a pool invitation (authenticated users only).
Path parameters:
  - uuid
Request body: yes

### call_reviewer_pools_decline
POST /api/call-reviewer-pools/{uuid}/decline/
Summary: Decline a pool invitation (authenticated users only)
Description: Decline a pool invitation (authenticated users only).
Path parameters:
  - uuid
Request body: yes

### call_reviewer_pools_force_accept
POST /api/call-reviewer-pools/{uuid}/force-accept/
Summary: Force-accept a pool invitation (manager override)
Description: Force-accept a pool invitation (manager override).
Path parameters:
  - uuid
Request body: yes

============================================================
## call-rounds  (module: waldur_api_client.api.call_rounds)
============================================================

### call_rounds_list
GET /api/call-rounds/

### call_rounds_count
HEAD /api/call-rounds/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### call_rounds_retrieve
GET /api/call-rounds/{uuid}/
Path parameters:
  - uuid

### call_rounds_reviewers_list
GET /api/call-rounds/{uuid}/reviewers/
Summary: Return list of reviewers for round
Description: Return list of reviewers for round.
Path parameters:
  - uuid

============================================================
## celery-stats  (module: waldur_api_client.api.celery_stats)
============================================================

### celery_stats_retrieve
GET /api/celery-stats/
Summary: Get Celery worker statistics
Description: Provides a comprehensive snapshot of all Celery workers' status.

This endpoint returns detailed information about:
- **active**: Tasks currently being executed by workers
- **scheduled**: Tasks scheduled for future execution (with ETA)
- **reserved**: Tasks received by workers but not yet starte...

============================================================
## chat  (module: waldur_api_client.api.chat)
============================================================

### chat_stream
POST /api/chat/stream/
Request body: yes

============================================================
## chat-messages  (module: waldur_api_client.api.chat_messages)
============================================================

### chat_messages_list
GET /api/chat-messages/
Query parameters (4):
  - feedback_score
  - include_history
  - is_flagged
  - thread

### chat_messages_feedback
POST /api/chat-messages/{uuid}/feedback/
Summary: Submit or update feedback for an assistant message
Path parameters:
  - uuid
Request body: yes

============================================================
## chat-quota  (module: waldur_api_client.api.chat_quota)
============================================================

### chat_quota_set_quota
POST /api/chat-quota/set_quota/
Summary: Set token quota for user
Description: Allows staff/support to set token quota limits for a specific user. Configure daily, weekly, and monthly limits:
- Omit field or send `null`: Use system default
- `-1`: Unlimited (no quota enforcement)
- `0` or positive integer: Specific token limit
Request body: yes

### chat_quota_usage_retrieve
GET /api/chat-quota/usage/
Summary: Get current token quota and usage for the requesting user
Description: Get current token quota and usage for the requesting user.

        Returns token quota for all periods (daily, weekly, monthly):
        - limit: User's custom limit (null = use system default, -1 = unlimited, or positive integer)
        - usage: Tokens used in current period
        - remainin...
Query parameters (1):
  - user_uuid (required) — UUID of user to view quota for (staff/support only). Omit to view your own quota.

============================================================
## chat-sessions  (module: waldur_api_client.api.chat_sessions)
============================================================

### chat_sessions_list
GET /api/chat-sessions/
Query parameters (1):
  - field

### chat_sessions_current_retrieve
GET /api/chat-sessions/current/
Summary: Get or create current user's chat session
Description: Returns the current user's chat session, creating it if it doesn't exist.
Query parameters (1):
  - field

### chat_sessions_retrieve
GET /api/chat-sessions/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

============================================================
## chat-system-prompts  (module: waldur_api_client.api.chat_system_prompts)
============================================================

### chat_system_prompts_list
GET /api/chat-system-prompts/

### chat_system_prompts_count
HEAD /api/chat-system-prompts/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### chat_system_prompts_create
POST /api/chat-system-prompts/
Request body: yes

### chat_system_prompts_retrieve
GET /api/chat-system-prompts/{uuid}/
Path parameters:
  - uuid

### chat_system_prompts_update
PUT /api/chat-system-prompts/{uuid}/
Path parameters:
  - uuid
Request body: yes

### chat_system_prompts_partial_update
PATCH /api/chat-system-prompts/{uuid}/
Path parameters:
  - uuid
Request body: yes

### chat_system_prompts_destroy
DELETE /api/chat-system-prompts/{uuid}/
Path parameters:
  - uuid

### chat_system_prompts_activate
POST /api/chat-system-prompts/{uuid}/activate/
Summary: Activate a system prompt
Description: Set this prompt as the active one. Deactivates any currently active prompt.
Path parameters:
  - uuid
Request body: yes

### chat_system_prompts_deactivate
POST /api/chat-system-prompts/{uuid}/deactivate/
Summary: Deactivate the active system prompt
Description: Deactivate this prompt. The system will fall back to Constance overrides or built-in defaults.
Path parameters:
  - uuid
Request body: yes

============================================================
## chat-threads  (module: waldur_api_client.api.chat_threads)
============================================================

### chat_threads_list
GET /api/chat-threads/
Query parameters (17):
  - created
  - field
  - has_feedback
  - input_tokens_max
  - input_tokens_min
  - is_archived
  - is_flagged
  - max_severity
  - modified
  - o — Ordering
  - output_tokens_max
  - output_tokens_min
  - query
  - scope
  - total_tokens_max
  - total_tokens_min
  - user

### chat_threads_retrieve
GET /api/chat-threads/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### chat_threads_archive
POST /api/chat-threads/{uuid}/archive/
Summary: Archive thread
Description: Archive a thread (soft delete).
Path parameters:
  - uuid

### chat_threads_cancel
POST /api/chat-threads/{uuid}/cancel/
Summary: Cancel active stream
Description: Request cancellation of the active LLM stream for this thread.
Path parameters:
  - uuid
Request body: yes

### chat_threads_unarchive
POST /api/chat-threads/{uuid}/unarchive/
Summary: Unarchive thread
Description: Restore an archived thread.
Path parameters:
  - uuid

============================================================
## chat-tools  (module: waldur_api_client.api.chat_tools)
============================================================

### chat_tools_execute
POST /api/chat-tools/execute/
Summary: Execute a tool and return the result
Description: Execute a tool and return the result.
Request body: yes

============================================================
## checklists-admin  (module: waldur_api_client.api.checklists_admin)
============================================================

### checklists_admin_list
GET /api/checklists-admin/
Query parameters (2):
  - checklist_type — Type of compliance this checklist addresses
  - checklist_type__in — Filter by multiple checklist types

### checklists_admin_count
HEAD /api/checklists-admin/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - checklist_type — Type of compliance this checklist addresses
  - checklist_type__in — Filter by multiple checklist types

### checklists_admin_create
POST /api/checklists-admin/
Request body: yes

### checklists_admin_retrieve
GET /api/checklists-admin/{uuid}/
Path parameters:
  - uuid

### checklists_admin_update
PUT /api/checklists-admin/{uuid}/
Path parameters:
  - uuid
Request body: yes

### checklists_admin_partial_update
PATCH /api/checklists-admin/{uuid}/
Path parameters:
  - uuid
Request body: yes

### checklists_admin_destroy
DELETE /api/checklists-admin/{uuid}/
Path parameters:
  - uuid

### checklists_admin_checklist_questions
GET /api/checklists-admin/{uuid}/questions/
Summary: Return checklist questions
Description: Return checklist questions.
Path parameters:
  - uuid
Query parameters (2):
  - checklist_type — Type of compliance this checklist addresses
  - checklist_type__in — Filter by multiple checklist types

============================================================
## checklists-admin-question-dependencies  (module: waldur_api_client.api.checklists_admin_question_dependencies)
============================================================

### checklists_admin_question_dependencies_list
GET /api/checklists-admin-question-dependencies/
Query parameters (2):
  - depends_on_question_uuid
  - question_uuid

### checklists_admin_question_dependencies_count
HEAD /api/checklists-admin-question-dependencies/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - depends_on_question_uuid
  - question_uuid

### checklists_admin_question_dependencies_create
POST /api/checklists-admin-question-dependencies/
Request body: yes

### checklists_admin_question_dependencies_retrieve
GET /api/checklists-admin-question-dependencies/{uuid}/
Path parameters:
  - uuid

### checklists_admin_question_dependencies_update
PUT /api/checklists-admin-question-dependencies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### checklists_admin_question_dependencies_partial_update
PATCH /api/checklists-admin-question-dependencies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### checklists_admin_question_dependencies_destroy
DELETE /api/checklists-admin-question-dependencies/{uuid}/
Path parameters:
  - uuid

============================================================
## checklists-admin-question-options  (module: waldur_api_client.api.checklists_admin_question_options)
============================================================

### checklists_admin_question_options_list
GET /api/checklists-admin-question-options/
Query parameters (1):
  - question_uuid

### checklists_admin_question_options_count
HEAD /api/checklists-admin-question-options/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - question_uuid

### checklists_admin_question_options_create
POST /api/checklists-admin-question-options/
Request body: yes

### checklists_admin_question_options_retrieve
GET /api/checklists-admin-question-options/{uuid}/
Path parameters:
  - uuid

### checklists_admin_question_options_update
PUT /api/checklists-admin-question-options/{uuid}/
Path parameters:
  - uuid
Request body: yes

### checklists_admin_question_options_partial_update
PATCH /api/checklists-admin-question-options/{uuid}/
Path parameters:
  - uuid
Request body: yes

### checklists_admin_question_options_destroy
DELETE /api/checklists-admin-question-options/{uuid}/
Path parameters:
  - uuid

============================================================
## checklists-admin-questions  (module: waldur_api_client.api.checklists_admin_questions)
============================================================

### checklists_admin_questions_list
GET /api/checklists-admin-questions/
Query parameters (3):
  - checklist_type — Type of compliance this checklist addresses
  - checklist_uuid
  - has_onboarding_mapping — Filter questions that have onboarding metadata mapping

### checklists_admin_questions_count
HEAD /api/checklists-admin-questions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - checklist_type — Type of compliance this checklist addresses
  - checklist_uuid
  - has_onboarding_mapping — Filter questions that have onboarding metadata mapping

### checklists_admin_questions_create
POST /api/checklists-admin-questions/
Request body: yes

### checklists_admin_questions_retrieve
GET /api/checklists-admin-questions/{uuid}/
Path parameters:
  - uuid

### checklists_admin_questions_update
PUT /api/checklists-admin-questions/{uuid}/
Path parameters:
  - uuid
Request body: yes

### checklists_admin_questions_partial_update
PATCH /api/checklists-admin-questions/{uuid}/
Path parameters:
  - uuid
Request body: yes

### checklists_admin_questions_destroy
DELETE /api/checklists-admin-questions/{uuid}/
Path parameters:
  - uuid

============================================================
## coi-detection-jobs  (module: waldur_api_client.api.coi_detection_jobs)
============================================================

### coi_detection_jobs_list
GET /api/coi-detection-jobs/
Query parameters (4):
  - call_uuid
  - job_type
  - o — Ordering
  - state

### coi_detection_jobs_count
HEAD /api/coi-detection-jobs/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - call_uuid
  - job_type
  - o — Ordering
  - state

### coi_detection_jobs_retrieve
GET /api/coi-detection-jobs/{uuid}/
Path parameters:
  - uuid

============================================================
## coi-disclosures  (module: waldur_api_client.api.coi_disclosures)
============================================================

### coi_disclosures_list
GET /api/coi-disclosures/
Query parameters (5):
  - call_uuid
  - certified
  - is_current
  - o — Ordering
  - reviewer_uuid

### coi_disclosures_count
HEAD /api/coi-disclosures/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - call_uuid
  - certified
  - is_current
  - o — Ordering
  - reviewer_uuid

### coi_disclosures_create
POST /api/coi-disclosures/
Request body: yes

### coi_disclosures_retrieve
GET /api/coi-disclosures/{uuid}/
Path parameters:
  - uuid

============================================================
## component-user-usage-limits  (module: waldur_api_client.api.component_user_usage_limits)
============================================================

### component_user_usage_limits_list
GET /api/component-user-usage-limits/
Summary: List component usage limits for users
Description: Returns a paginated list of usage limits set for specific users on resource components.
Query parameters (5):
  - component_type — Component type
  - offering_uuid — Offering UUID
  - resource — Resource URL
  - resource_uuid — Resource UUID
  - username — Username

### component_user_usage_limits_count
HEAD /api/component-user-usage-limits/
Summary: List component usage limits for users
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - component_type — Component type
  - offering_uuid — Offering UUID
  - resource — Resource URL
  - resource_uuid — Resource UUID
  - username — Username

### component_user_usage_limits_create
POST /api/component-user-usage-limits/
Summary: Create a component usage limit for a user
Description: Sets a usage limit for a specific user on a resource's component. This is only applicable for offerings that support per-user consumption limitation.
Request body: yes

### component_user_usage_limits_retrieve
GET /api/component-user-usage-limits/{uuid}/
Summary: Retrieve a component usage limit
Description: Returns the details of a specific user's usage limit for a component.
Path parameters:
  - uuid

### component_user_usage_limits_update
PUT /api/component-user-usage-limits/{uuid}/
Summary: Update a component usage limit
Description: Updates an existing usage limit for a user on a component.
Path parameters:
  - uuid
Request body: yes

### component_user_usage_limits_partial_update
PATCH /api/component-user-usage-limits/{uuid}/
Summary: Partially update a component usage limit
Description: Partially updates an existing usage limit for a user on a component.
Path parameters:
  - uuid
Request body: yes

### component_user_usage_limits_destroy
DELETE /api/component-user-usage-limits/{uuid}/
Summary: Delete a component usage limit
Description: Removes a usage limit for a user on a component.
Path parameters:
  - uuid

============================================================
## configuration  (module: waldur_api_client.api.configuration)
============================================================

### configuration_retrieve
GET /api/configuration/
Summary: Get public configuration
Description: Returns a dictionary of public settings for the Waldur deployment. This includes feature flags, authentication methods, and other configuration details that are safe to expose to any user.

============================================================
## conflicts-of-interest  (module: waldur_api_client.api.conflicts_of_interest)
============================================================

### conflicts_of_interest_list
GET /api/conflicts-of-interest/
Query parameters (10):
  - call_uuid
  - coi_type
  - detection_method
  - o — Ordering
  - proposal_uuid
  - reviewer_name
  - reviewer_uuid
  - round_uuid
  - severity
  - status

### conflicts_of_interest_count
HEAD /api/conflicts-of-interest/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (10):
  - call_uuid
  - coi_type
  - detection_method
  - o — Ordering
  - proposal_uuid
  - reviewer_name
  - reviewer_uuid
  - round_uuid
  - severity
  - status

### conflicts_of_interest_retrieve
GET /api/conflicts-of-interest/{uuid}/
Path parameters:
  - uuid

### conflicts_of_interest_update
PUT /api/conflicts-of-interest/{uuid}/
Path parameters:
  - uuid
Request body: yes

### conflicts_of_interest_partial_update
PATCH /api/conflicts-of-interest/{uuid}/
Path parameters:
  - uuid
Request body: yes

### conflicts_of_interest_dismiss
POST /api/conflicts-of-interest/{uuid}/dismiss/
Summary: Dismiss a conflict of interest (not a real conflict)
Description: Dismiss a conflict of interest (not a real conflict).
Path parameters:
  - uuid
Request body: yes

### conflicts_of_interest_recuse
POST /api/conflicts-of-interest/{uuid}/recuse/
Summary: Recuse reviewer from the proposal
Description: Recuse reviewer from the proposal.
Path parameters:
  - uuid
Request body: yes

### conflicts_of_interest_waive
POST /api/conflicts-of-interest/{uuid}/waive/
Summary: Waive a conflict with a management plan
Description: Waive a conflict with a management plan.
Path parameters:
  - uuid
Request body: yes

============================================================
## credit-transactions  (module: waldur_api_client.api.credit_transactions)
============================================================

### credit_transactions_list
GET /api/credit-transactions/
Query parameters (4):
  - credit_uuid
  - customer_uuid
  - o — Ordering
  - transaction_type

### credit_transactions_count
HEAD /api/credit-transactions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - credit_uuid
  - customer_uuid
  - o — Ordering
  - transaction_type

### credit_transactions_retrieve
GET /api/credit-transactions/{uuid}/
Path parameters:
  - uuid

============================================================
## customer-affiliates  (module: waldur_api_client.api.customer_affiliates)
============================================================

### customer_affiliates_list
GET /api/customer-affiliates/
Query parameters (6):
  - affiliate_name
  - affiliate_uuid
  - customer_name
  - customer_uuid
  - is_active
  - o — Ordering

### customer_affiliates_count
HEAD /api/customer-affiliates/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - affiliate_name
  - affiliate_uuid
  - customer_name
  - customer_uuid
  - is_active
  - o — Ordering

### customer_affiliates_create
POST /api/customer-affiliates/
Request body: yes

### customer_affiliates_retrieve
GET /api/customer-affiliates/{uuid}/
Path parameters:
  - uuid

### customer_affiliates_update
PUT /api/customer-affiliates/{uuid}/
Path parameters:
  - uuid
Request body: yes

### customer_affiliates_partial_update
PATCH /api/customer-affiliates/{uuid}/
Path parameters:
  - uuid
Request body: yes

### customer_affiliates_destroy
DELETE /api/customer-affiliates/{uuid}/
Path parameters:
  - uuid

### customer_affiliates_accruals_list
GET /api/customer-affiliates/{uuid}/accruals/
Summary: List fees accrued from this affiliate link
Description: List fees accrued from this affiliate link. Exposes the fee amount and invoice period only — never the referred customer's invoice contents.
Path parameters:
  - uuid
Query parameters (6):
  - affiliate_name
  - affiliate_uuid
  - customer_name
  - customer_uuid
  - is_active
  - o — Ordering

### customer_affiliates_earnings_retrieve
GET /api/customer-affiliates/{uuid}/earnings/
Summary: Earnings summary of this affiliate link: lifetime total, per-month series and the affiliate organization's withdrawable credit balance
Description: Earnings summary of this affiliate link: lifetime total, per-month series and the affiliate organization's withdrawable credit balance.
Path parameters:
  - uuid

============================================================
## customer-credits  (module: waldur_api_client.api.customer_credits)
============================================================

### customer_credits_list
GET /api/customer-credits/
Query parameters (5):
  - customer_name
  - customer_slug
  - customer_uuid
  - o — Ordering
  - query

### customer_credits_count
HEAD /api/customer-credits/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - customer_name
  - customer_slug
  - customer_uuid
  - o — Ordering
  - query

### customer_credits_create
POST /api/customer-credits/
Request body: yes

### customer_credits_retrieve
GET /api/customer-credits/{uuid}/
Path parameters:
  - uuid

### customer_credits_update
PUT /api/customer-credits/{uuid}/
Path parameters:
  - uuid
Request body: yes

### customer_credits_partial_update
PATCH /api/customer-credits/{uuid}/
Path parameters:
  - uuid
Request body: yes

### customer_credits_destroy
DELETE /api/customer-credits/{uuid}/
Path parameters:
  - uuid

### customer_credits_adjust_withdrawable
POST /api/customer-credits/{uuid}/adjust_withdrawable/
Summary: Staff adjustment of the withdrawable part of the credit
Description: Staff adjustment of the withdrawable part of the credit. Records a signed ledger entry with a comment and changes the credit value by the same amount.
Path parameters:
  - uuid
Request body: yes

### customer_credits_apply_compensations
POST /api/customer-credits/{uuid}/apply_compensations/
Path parameters:
  - uuid

### customer_credits_clear_compensations
POST /api/customer-credits/{uuid}/clear_compensations/
Path parameters:
  - uuid

### customer_credits_consumptions_list
GET /api/customer-credits/{uuid}/consumptions/
Summary: Get credit consumption history grouped by month
Description: Get credit consumption history grouped by month.
Path parameters:
  - uuid
Query parameters (5):
  - customer_name
  - customer_slug
  - customer_uuid
  - o — Ordering
  - query

============================================================
## customer-permissions-reviews  (module: waldur_api_client.api.customer_permissions_reviews)
============================================================

### customer_permissions_reviews_list
GET /api/customer-permissions-reviews/
Query parameters (5):
  - closed
  - customer_uuid — Customer UUID
  - is_pending — Is pending
  - o — Ordering
  - reviewer_uuid — Reviewer UUID

### customer_permissions_reviews_count
HEAD /api/customer-permissions-reviews/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - closed
  - customer_uuid — Customer UUID
  - is_pending — Is pending
  - o — Ordering
  - reviewer_uuid — Reviewer UUID

### customer_permissions_reviews_retrieve
GET /api/customer-permissions-reviews/{uuid}/
Path parameters:
  - uuid

### customer_permissions_reviews_close
POST /api/customer-permissions-reviews/{uuid}/close/
Summary: Close customer permission review
Path parameters:
  - uuid

============================================================
## customer-quotas  (module: waldur_api_client.api.customer_quotas)
============================================================

### customer_quotas_list
GET /api/customer-quotas/
Summary: List customer quotas
Description: List customer quotas.
Query parameters (1):
  - quota_name — Name of the quota

### customer_quotas_count
HEAD /api/customer-quotas/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - quota_name — Name of the quota

============================================================
## customers  (module: waldur_api_client.api.customers)
============================================================

### customers_list
GET /api/customers/
Summary: List customers
Description: Retrieve a list of customers. The list is filtered based on the user's permissions.
Query parameters (24):
  - abbreviation — Abbreviation
  - accounting_is_running — Filter by whether accounting is running.
  - agreement_number
  - archived
  - backend_id
  - contact_details — Contact details
  - current_user_has_project_create_permission — Return a list of customers where current user has project create permission.
  - current_user_has_role — Multiple values may be separated by commas.
  - field
  - has_resources — Filter by customers with resources.
  - is_call_managing_organization — Filter by customers that are call managing organizations.
  - is_service_provider — Filter by customers that are service providers.
  - name — Name
  - name_exact — Name (exact)
  - native_name — Native name
  - o — Which field to use when ordering the results.
  - organization_group_name — Organization group name
  - organization_group_uuid — Organization group UUID
  - owned_by_current_user — Return a list of customers where current user is owner.
  - query — Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
  - registration_code
  - service_provider_uuid — Filter by service provider UUID.
  - slug — Slug
  - user_uuid — Filter by user UUID.

### customers_count
HEAD /api/customers/
Summary: List customers
Description: Get number of items in the collection matching the request parameters.
Query parameters (23):
  - abbreviation — Abbreviation
  - accounting_is_running — Filter by whether accounting is running.
  - agreement_number
  - archived
  - backend_id
  - contact_details — Contact details
  - current_user_has_project_create_permission — Return a list of customers where current user has project create permission.
  - current_user_has_role — Multiple values may be separated by commas.
  - has_resources — Filter by customers with resources.
  - is_call_managing_organization — Filter by customers that are call managing organizations.
  - is_service_provider — Filter by customers that are service providers.
  - name — Name
  - name_exact — Name (exact)
  - native_name — Native name
  - o — Which field to use when ordering the results.
  - organization_group_name — Organization group name
  - organization_group_uuid — Organization group UUID
  - owned_by_current_user — Return a list of customers where current user is owner.
  - query — Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
  - registration_code
  - service_provider_uuid — Filter by service provider UUID.
  - slug — Slug
  - user_uuid — Filter by user UUID.

### customers_create
POST /api/customers/
Summary: Create a new customer
Description: A new customer can only be created by users with staff privilege.
Request body: yes

### customers_countries_list
GET /api/customers/countries/
Summary: Get list of available countries
Description: Returns a list of countries that can be used when creating or updating a customer. The list can be configured by the service provider.
Query parameters (23):
  - abbreviation — Abbreviation
  - accounting_is_running — Filter by whether accounting is running.
  - agreement_number
  - archived
  - backend_id
  - contact_details — Contact details
  - current_user_has_project_create_permission — Return a list of customers where current user has project create permission.
  - current_user_has_role — Multiple values may be separated by commas.
  - has_resources — Filter by customers with resources.
  - is_call_managing_organization — Filter by customers that are call managing organizations.
  - is_service_provider — Filter by customers that are service providers.
  - name — Name
  - name_exact — Name (exact)
  - native_name — Native name
  - o — Which field to use when ordering the results.
  - organization_group_name — Organization group name
  - organization_group_uuid — Organization group UUID
  - owned_by_current_user — Return a list of customers where current user is owner.
  - query — Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
  - registration_code
  - service_provider_uuid — Filter by service provider UUID.
  - slug — Slug
  - user_uuid — Filter by user UUID.

### customers_countries_count
HEAD /api/customers/countries/
Summary: Get list of available countries
Description: Get number of items in the collection matching the request parameters.
Query parameters (23):
  - abbreviation — Abbreviation
  - accounting_is_running — Filter by whether accounting is running.
  - agreement_number
  - archived
  - backend_id
  - contact_details — Contact details
  - current_user_has_project_create_permission — Return a list of customers where current user has project create permission.
  - current_user_has_role — Multiple values may be separated by commas.
  - has_resources — Filter by customers with resources.
  - is_call_managing_organization — Filter by customers that are call managing organizations.
  - is_service_provider — Filter by customers that are service providers.
  - name — Name
  - name_exact — Name (exact)
  - native_name — Native name
  - o — Which field to use when ordering the results.
  - organization_group_name — Organization group name
  - organization_group_uuid — Organization group UUID
  - owned_by_current_user — Return a list of customers where current user is owner.
  - query — Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
  - registration_code
  - service_provider_uuid — Filter by service provider UUID.
  - slug — Slug
  - user_uuid — Filter by user UUID.

### customers_project_metadata_compliance_details_list
GET /api/customers/{customer_uuid}/project-metadata-compliance-details/
Summary: Get detailed project metadata compliance
Description: Provides detailed compliance status for all projects within a customer, including individual answers and completion status.
Path parameters:
  - customer_uuid — UUID of the customer

### customers_project_metadata_compliance_details_count
HEAD /api/customers/{customer_uuid}/project-metadata-compliance-details/
Summary: Get detailed project metadata compliance
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - customer_uuid — UUID of the customer

### customers_project_metadata_compliance_overview_list
GET /api/customers/{customer_uuid}/project-metadata-compliance-overview/
Summary: Get project metadata compliance overview
Description: Provides aggregated statistics about project metadata compliance for all projects within a customer.
Path parameters:
  - customer_uuid — UUID of the customer

### customers_project_metadata_compliance_overview_count
HEAD /api/customers/{customer_uuid}/project-metadata-compliance-overview/
Summary: Get project metadata compliance overview
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - customer_uuid — UUID of the customer

### customers_project_metadata_compliance_projects_list
GET /api/customers/{customer_uuid}/project-metadata-compliance-projects/
Summary: List projects with compliance data
Description: Provides a paginated list of projects with their checklist completion status and answer details.
Path parameters:
  - customer_uuid — UUID of the customer

### customers_project_metadata_compliance_projects_count
HEAD /api/customers/{customer_uuid}/project-metadata-compliance-projects/
Summary: List projects with compliance data
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - customer_uuid — UUID of the customer

### customers_project_metadata_question_answers_list
GET /api/customers/{customer_uuid}/project-metadata-question-answers/
Summary: List questions with project answers
Description: Provides a paginated list of all questions from the customer's compliance checklist, including the answers given in each project.
Path parameters:
  - customer_uuid — UUID of the customer

### customers_project_metadata_question_answers_count
HEAD /api/customers/{customer_uuid}/project-metadata-question-answers/
Summary: List questions with project answers
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - customer_uuid — UUID of the customer

### customers_users_list
GET /api/customers/{customer_uuid}/users/
Summary: List users of a customer
Description: Lists all users who have a role in the specified customer or any of its projects. Requires permissions to list customer users.
Path parameters:
  - customer_uuid — UUID of the customer
Query parameters (19):
  - agreement_date — Agreement date after
  - civil_number
  - date_joined — Date joined after
  - description
  - email — Email
  - field
  - full_name — Full name
  - is_active — Is active
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering. Sort by a combination of first name, last name, and username.
  - organization — Organization
  - organization_role — Filter by one or more organization roles. Select a standard role or provide a custom role string. Can be specified multiple times.
  - phone_number
  - project_role — Filter by one or more project roles. Select a standard role or provide a custom role string. Can be specified multiple times.
  - registration_method
  - user_keyword — User keyword
  - username — Username

### customers_users_count
HEAD /api/customers/{customer_uuid}/users/
Summary: List users of a customer
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - customer_uuid — UUID of the customer
Query parameters (18):
  - agreement_date — Agreement date after
  - civil_number
  - date_joined — Date joined after
  - description
  - email — Email
  - full_name — Full name
  - is_active — Is active
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering. Sort by a combination of first name, last name, and username.
  - organization — Organization
  - organization_role — Filter by one or more organization roles. Select a standard role or provide a custom role string. Can be specified multiple times.
  - phone_number
  - project_role — Filter by one or more project roles. Select a standard role or provide a custom role string. Can be specified multiple times.
  - registration_method
  - user_keyword — User keyword
  - username — Username

### customers_retrieve
GET /api/customers/{uuid}/
Summary: Retrieve customer details
Description: Fetch the details of a specific customer by its UUID.
Path parameters:
  - uuid
Query parameters (1):
  - field

### customers_update
PUT /api/customers/{uuid}/
Summary: Update a customer
Description: Update the details of an existing customer. Requires customer owner or staff permissions.
Path parameters:
  - uuid
Request body: yes

### customers_partial_update
PATCH /api/customers/{uuid}/
Summary: Partially update a customer
Description: Partially update the details of an existing customer. Requires customer owner or staff permissions.
Path parameters:
  - uuid
Request body: yes

### customers_destroy
DELETE /api/customers/{uuid}/
Summary: Delete a customer
Description: Delete a customer. This action is only available to staff users. If a customer has any active projects, the deletion request will fail with a 409 Conflict response.
Path parameters:
  - uuid

### customers_add_user
POST /api/customers/{uuid}/add_user/
Summary: Grant a role to a user
Description: Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
Path parameters:
  - uuid
Request body: yes

### customers_contact
POST /api/customers/{uuid}/contact/
Summary: Update customer contact details
Description: Update organization contact information. Requires CUSTOMER_CONTACT_UPDATE or CUSTOMER.UPDATE permission.
Path parameters:
  - uuid
Request body: yes

### customers_delete_user
POST /api/customers/{uuid}/delete_user/
Summary: Revoke a role from a user
Description: Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
Path parameters:
  - uuid
Request body: yes

### customers_history_list
GET /api/customers/{uuid}/history/
Summary: Get version history
Description: Returns the version history for this object. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (25):
  - abbreviation — Abbreviation
  - accounting_is_running — Filter by whether accounting is running.
  - agreement_number
  - archived
  - backend_id
  - contact_details — Contact details
  - created_after — Filter versions created after this timestamp (ISO 8601)
  - created_before — Filter versions created before this timestamp (ISO 8601)
  - current_user_has_project_create_permission — Return a list of customers where current user has project create permission.
  - current_user_has_role — Multiple values may be separated by commas.
  - has_resources — Filter by customers with resources.
  - is_call_managing_organization — Filter by customers that are call managing organizations.
  - is_service_provider — Filter by customers that are service providers.
  - name — Name
  - name_exact — Name (exact)
  - native_name — Native name
  - o — Which field to use when ordering the results.
  - organization_group_name — Organization group name
  - organization_group_uuid — Organization group UUID
  - owned_by_current_user — Return a list of customers where current user is owner.
  - query — Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
  - registration_code
  - service_provider_uuid — Filter by service provider UUID.
  - slug — Slug
  - user_uuid — Filter by user UUID.

### customers_history_at_retrieve
GET /api/customers/{uuid}/history/at/
Summary: Get object state at a specific timestamp
Description: Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (1):
  - timestamp (required) — ISO 8601 timestamp to query the object state at

### customers_list_users_list
GET /api/customers/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### customers_list_users_count
HEAD /api/customers/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### customers_project_digest_config_retrieve
GET /api/customers/{uuid}/project-digest-config/
Summary: Get project digest configuration
Description: Retrieve the project digest email configuration for this organization.
Path parameters:
  - uuid

### customers_project_digest_config_preview
POST /api/customers/{uuid}/project-digest-config/preview/
Summary: Preview digest for a project
Description: Returns rendered HTML preview of the digest for a specific project.
Path parameters:
  - uuid
Request body: yes

### customers_project_digest_config_send_test
POST /api/customers/{uuid}/project-digest-config/send-test/
Summary: Send a test digest email
Description: Send a test digest email to the requesting user.
Path parameters:
  - uuid

### customers_stats_retrieve
GET /api/customers/{uuid}/stats/
Summary: Get customer resource usage statistics
Description: Provides statistics about the resource usage (e.g., CPU, RAM, storage) for all projects within a customer. Can be filtered to show usage for the current month only.
Path parameters:
  - uuid
Query parameters (1):
  - for_current_month — If true, returns usage data for the current month only. Otherwise, returns total usage.

### customers_update_project_digest_config_update
PUT /api/customers/{uuid}/update-project-digest-config/
Summary: Update project digest configuration
Description: Update the project digest email configuration for this organization.
Path parameters:
  - uuid
Request body: yes

### customers_update_project_digest_config_partial_update
PATCH /api/customers/{uuid}/update-project-digest-config/
Summary: Update project digest configuration
Description: Update the project digest email configuration for this organization.
Path parameters:
  - uuid
Request body: yes

### customers_update_default_affiliations
POST /api/customers/{uuid}/update_default_affiliations/
Summary: Update default affiliations for an organization
Description: Replaces the organization's default affiliation list. Project creators in the organization will be limited to choosing from this list when affiliating a project. Staff-only.
Path parameters:
  - uuid
Request body: yes

### customers_update_organization_groups
POST /api/customers/{uuid}/update_organization_groups/
Summary: Update organization groups for a customer
Description: Assigns a customer to one or more organization groups. This action is restricted to staff users.
Path parameters:
  - uuid
Request body: yes

### customers_update_user
POST /api/customers/{uuid}/update_user/
Summary: Update a user's role expiration
Description: Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
Path parameters:
  - uuid
Request body: yes

============================================================
## daily-quotas  (module: waldur_api_client.api.daily_quotas)
============================================================

### daily_quotas_retrieve
GET /api/daily-quotas/
Query parameters (4):
  - end — End date in format YYYY-MM-DD
  - quota_names — List of quota names
  - scope — UUID of the scope object
  - start — Start date in format YYYY-MM-DD

============================================================
## data-access-logs  (module: waldur_api_client.api.data_access_logs)
============================================================

### data_access_logs_list
GET /api/data-access-logs/
Query parameters (7):
  - accessor_type — Type of accessor
  - accessor_uuid
  - end_date
  - o — Ordering
  - query
  - start_date
  - user_uuid

### data_access_logs_count
HEAD /api/data-access-logs/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (7):
  - accessor_type — Type of accessor
  - accessor_uuid
  - end_date
  - o — Ordering
  - query
  - start_date
  - user_uuid

### data_access_logs_retrieve
GET /api/data-access-logs/{uuid}/
Path parameters:
  - uuid

### data_access_logs_destroy
DELETE /api/data-access-logs/{uuid}/
Path parameters:
  - uuid

============================================================
## database-stats  (module: waldur_api_client.api.database_stats)
============================================================

### database_stats_retrieve
GET /api/database-stats/
Summary: Get comprehensive database statistics
Description: Retrieves comprehensive statistics about the PostgreSQL database including:
- **Table statistics**: Top 10 largest tables by size
- **Connection statistics**: Active, idle, and waiting connections with utilization
- **Database size**: Total size, data size, and index size
- **Cache performance**:...

============================================================
## debug  (module: waldur_api_client.api.debug)
============================================================

### debug_pubsub_circuit_breaker_retrieve
GET /api/debug/pubsub/circuit_breaker/
Summary: Get circuit breaker state
Description: Get current STOMP circuit breaker state and statistics.

Returns:
- state: Current state (closed/open/half_open)
- failure_count: Number of consecutive failures
- success_count: Successes since last state change
- last_failure_time: Timestamp of last failure
- last_state_change: When state last c...

### debug_pubsub_circuit_breaker_reset
POST /api/debug/pubsub/circuit_breaker_reset/
Summary: Reset circuit breaker
Description: Manually reset the STOMP circuit breaker to CLOSED state.

Use with caution - only when RabbitMQ is confirmed healthy.

Requires staff permissions.

### debug_pubsub_dead_letter_queue_retrieve
GET /api/debug/pubsub/dead_letter_queue/
Summary: Get dead letter queue status
Description: Get dead letter queue (DLQ) statistics.

The DLQ receives messages that failed to be delivered to their original
destination. This endpoint shows the current DLQ status.

Note: DLQ is configured per-vhost. This endpoint checks all vhosts
for queues with 'dlq' in the name.

Requires staff permissi...

### debug_pubsub_message_state_cache_retrieve
GET /api/debug/pubsub/message_state_cache/
Summary: Get message state cache statistics
Description: Get message state tracker cache statistics for idempotency.

The message state tracker prevents duplicate message sends by caching
the hash of message content. This endpoint provides cache statistics.

Query params:
- resource_uuid: Filter by specific resource
- message_type: Filter by message ty...

### debug_pubsub_metrics_retrieve
GET /api/debug/pubsub/metrics/
Summary: Get publishing metrics
Description: Get message publishing metrics and statistics.

Returns:
- messages_sent: Total messages successfully sent
- messages_failed: Total failed message attempts
- messages_retried: Messages that required retry
- messages_skipped: Messages skipped due to circuit breaker
- circuit_breaker_trips: Number ...

### debug_pubsub_metrics_reset
POST /api/debug/pubsub/metrics_reset/
Summary: Reset publishing metrics
Description: Reset all publishing metrics counters to zero.

Requires staff permissions.

### debug_pubsub_overview_retrieve
GET /api/debug/pubsub/overview/
Summary: Get pubsub system health overview
Description: Dashboard overview of pubsub system health.

Combines circuit breaker state, publishing metrics, and health indicators
into a single response suitable for monitoring dashboards.

Requires staff permissions.

### debug_pubsub_queues_retrieve
GET /api/debug/pubsub/queues/
Summary: Get subscription queues overview
Description: Get overview of subscription queues from RabbitMQ.

Returns summary of subscription queues across all vhosts including
message counts and queue statistics.

Note: For detailed queue management, use /api/rabbitmq-stats/ endpoint.

Requires staff permissions.

============================================================
## digitalocean-droplets  (module: waldur_api_client.api.digitalocean_droplets)
============================================================

### digitalocean_droplets_list
GET /api/digitalocean-droplets/
Query parameters (18):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### digitalocean_droplets_count
HEAD /api/digitalocean-droplets/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (17):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### digitalocean_droplets_create
POST /api/digitalocean-droplets/
Request body: yes

### digitalocean_droplets_retrieve
GET /api/digitalocean-droplets/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### digitalocean_droplets_update
PUT /api/digitalocean-droplets/{uuid}/
Path parameters:
  - uuid
Request body: yes

### digitalocean_droplets_partial_update
PATCH /api/digitalocean-droplets/{uuid}/
Path parameters:
  - uuid
Request body: yes

### digitalocean_droplets_destroy
DELETE /api/digitalocean-droplets/{uuid}/
Path parameters:
  - uuid

### digitalocean_droplets_pull
POST /api/digitalocean-droplets/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### digitalocean_droplets_resize
POST /api/digitalocean-droplets/{uuid}/resize/
Summary: To resize droplet, submit a POST request to the instance URL, specifying URI of a target size
Description: To resize droplet, submit a POST request to the instance URL, specifying URI of a target size.

Pass {'disk': true} along with target size in order to perform permanent resizing,
which allows you to resize your disk space as well as CPU and RAM.
After increasing the disk size, you will not be abl...
Path parameters:
  - uuid
Request body: yes

### digitalocean_droplets_restart
POST /api/digitalocean-droplets/{uuid}/restart/
Path parameters:
  - uuid

### digitalocean_droplets_set_erred
POST /api/digitalocean-droplets/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### digitalocean_droplets_set_ok
POST /api/digitalocean-droplets/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### digitalocean_droplets_start
POST /api/digitalocean-droplets/{uuid}/start/
Path parameters:
  - uuid

### digitalocean_droplets_stop
POST /api/digitalocean-droplets/{uuid}/stop/
Path parameters:
  - uuid

### digitalocean_droplets_unlink
POST /api/digitalocean-droplets/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## digitalocean-images  (module: waldur_api_client.api.digitalocean_images)
============================================================

### digitalocean_images_list
GET /api/digitalocean-images/
Query parameters (5):
  - distribution
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - type

### digitalocean_images_count
HEAD /api/digitalocean-images/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - distribution
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - type

### digitalocean_images_retrieve
GET /api/digitalocean-images/{uuid}/
Path parameters:
  - uuid

============================================================
## digitalocean-regions  (module: waldur_api_client.api.digitalocean_regions)
============================================================

### digitalocean_regions_list
GET /api/digitalocean-regions/
Query parameters (2):
  - name — Name
  - name_exact — Name (exact)

### digitalocean_regions_count
HEAD /api/digitalocean-regions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - name — Name
  - name_exact — Name (exact)

### digitalocean_regions_retrieve
GET /api/digitalocean-regions/{uuid}/
Path parameters:
  - uuid

============================================================
## digitalocean-sizes  (module: waldur_api_client.api.digitalocean_sizes)
============================================================

### digitalocean_sizes_list
GET /api/digitalocean-sizes/
Query parameters (5):
  - cores
  - disk
  - name — Name
  - name_exact — Name (exact)
  - ram

### digitalocean_sizes_count
HEAD /api/digitalocean-sizes/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - cores
  - disk
  - name — Name
  - name_exact — Name (exact)
  - ram

### digitalocean_sizes_retrieve
GET /api/digitalocean-sizes/{uuid}/
Path parameters:
  - uuid

============================================================
## email-logs  (module: waldur_api_client.api.email_logs)
============================================================

### email_logs_list
GET /api/email-logs/
Query parameters (5):
  - body
  - emails
  - o — Ordering
  - sent_at
  - subject

### email_logs_count
HEAD /api/email-logs/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - body
  - emails
  - o — Ordering
  - sent_at
  - subject

### email_logs_retrieve
GET /api/email-logs/{uuid}/
Path parameters:
  - uuid

============================================================
## event-subscription-queues  (module: waldur_api_client.api.event_subscription_queues)
============================================================

### event_subscription_queues_list
GET /api/event-subscription-queues/
Query parameters (4):
  - event_subscription_uuid
  - o — Ordering
  - object_type
  - offering_uuid

### event_subscription_queues_count
HEAD /api/event-subscription-queues/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - event_subscription_uuid
  - o — Ordering
  - object_type
  - offering_uuid

### event_subscription_queues_retrieve
GET /api/event-subscription-queues/{uuid}/
Path parameters:
  - uuid

### event_subscription_queues_destroy
DELETE /api/event-subscription-queues/{uuid}/
Path parameters:
  - uuid

============================================================
## event-subscriptions  (module: waldur_api_client.api.event_subscriptions)
============================================================

### event_subscriptions_list
GET /api/event-subscriptions/
Query parameters (3):
  - o — Ordering
  - user_username
  - user_uuid

### event_subscriptions_count
HEAD /api/event-subscriptions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - o — Ordering
  - user_username
  - user_uuid

### event_subscriptions_create
POST /api/event-subscriptions/
Request body: yes

### event_subscriptions_retrieve
GET /api/event-subscriptions/{uuid}/
Path parameters:
  - uuid

### event_subscriptions_destroy
DELETE /api/event-subscriptions/{uuid}/
Path parameters:
  - uuid

### event_subscriptions_create_queue
POST /api/event-subscriptions/{uuid}/create_queue/
Summary: Create a RabbitMQ queue for receiving events for a specific offering and object type
Description: Create a RabbitMQ queue for receiving events for a specific offering and object type. The receiver must call this endpoint before subscribing via STOMP to ensure the queue is created with correct arguments (DLX, max-length, etc.).
Path parameters:
  - uuid
Request body: yes

============================================================
## events  (module: waldur_api_client.api.events)
============================================================

### events_list
GET /api/events/
Query parameters (11):
  - created_from
  - created_to
  - customer_uuid — Customer UUID
  - event_type — Filter by event type. Can be specified multiple times.
  - feature — Filter by feature (event group). Can be specified multiple times.
  - field
  - message
  - o — Ordering
  - project_uuid — Project UUID
  - scope — Filter by scope URL.
  - user_uuid — User UUID

### events_count
HEAD /api/events/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (10):
  - created_from
  - created_to
  - customer_uuid — Customer UUID
  - event_type — Filter by event type. Can be specified multiple times.
  - feature — Filter by feature (event group). Can be specified multiple times.
  - message
  - o — Ordering
  - project_uuid — Project UUID
  - scope — Filter by scope URL.
  - user_uuid — User UUID

### events_count_retrieve
GET /api/events/count/

### events_count_count
HEAD /api/events/count/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### events_event_groups_retrieve
GET /api/events/event_groups/
Summary: Returns a list of groups with event types
Description: Returns a list of groups with event types.
Group is used in exclude_features query param.

### events_event_groups_count
HEAD /api/events/event_groups/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### events_scope_types_retrieve
GET /api/events/scope_types/
Summary: Returns a list of scope types acceptable by events filter
Description: Returns a list of scope types acceptable by events filter.

### events_scope_types_count
HEAD /api/events/scope_types/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### events_retrieve
GET /api/events/{id}/
Path parameters:
  - id — A unique integer value identifying this event.
Query parameters (1):
  - field

============================================================
## events-stats  (module: waldur_api_client.api.events_stats)
============================================================

### events_stats_list
GET /api/events-stats/
Query parameters (3):
  - event_type — Filter by event type. Can be specified multiple times.
  - feature — Filter by feature (event group). Can be specified multiple times.
  - scope — Filter by scope URL.

### events_stats_count
HEAD /api/events-stats/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - event_type — Filter by event type. Can be specified multiple times.
  - feature — Filter by feature (event group). Can be specified multiple times.
  - scope — Filter by scope URL.

============================================================
## expertise-categories  (module: waldur_api_client.api.expertise_categories)
============================================================

### expertise_categories_list
GET /api/expertise-categories/
Query parameters (5):
  - code
  - level
  - name
  - o — Ordering
  - parent_uuid

### expertise_categories_count
HEAD /api/expertise-categories/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - code
  - level
  - name
  - o — Ordering
  - parent_uuid

### expertise_categories_retrieve
GET /api/expertise-categories/{uuid}/
Path parameters:
  - uuid

============================================================
## external-links  (module: waldur_api_client.api.external_links)
============================================================

### external_links_list
GET /api/external-links/
Summary: List external links
Description: Retrieve a list of external links available in the system.
Query parameters (2):
  - o — Which field to use when ordering the results.
  - query — Filter by name, link or description

### external_links_count
HEAD /api/external-links/
Summary: List external links
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - o — Which field to use when ordering the results.
  - query — Filter by name, link or description

### external_links_create
POST /api/external-links/
Summary: Create an external link
Description: Create a new external link. This action is restricted to staff users.
Request body: yes

### external_links_retrieve
GET /api/external-links/{uuid}/
Summary: Retrieve external link
Description: Fetch the details of a specific external link by its UUID.
Path parameters:
  - uuid

### external_links_update
PUT /api/external-links/{uuid}/
Summary: Update an external link
Description: Update an existing external link. This action is restricted to staff users.
Path parameters:
  - uuid
Request body: yes

### external_links_partial_update
PATCH /api/external-links/{uuid}/
Summary: Partially update an external link
Description: Partially update an existing external link. This action is restricted to staff users.
Path parameters:
  - uuid
Request body: yes

### external_links_destroy
DELETE /api/external-links/{uuid}/
Summary: Delete an external link
Description: Delete an existing external link. This action is restricted to staff users.
Path parameters:
  - uuid

============================================================
## feature-values  (module: waldur_api_client.api.feature_values)
============================================================

### feature_values
POST /api/feature-values/
Summary: Update feature flags
Description: Allows administrators to enable or disable specific feature flags in the system. The request should be a dictionary where keys are feature sections and values are dictionaries of feature keys and their boolean state.
Request body: yes

============================================================
## financial-reports  (module: waldur_api_client.api.financial_reports)
============================================================

### financial_reports_list
GET /api/financial-reports/
Query parameters (21):
  - abbreviation — Abbreviation
  - accounting_is_running — Filter by whether accounting is running.
  - agreement_number
  - archived
  - backend_id
  - contact_details — Contact details
  - current_user_has_project_create_permission — Return a list of customers where current user has project create permission.
  - current_user_has_role — Multiple values may be separated by commas.
  - customer_uuid — Filter by customer UUID.
  - month — Filter by month.
  - name — Name
  - name_exact — Name (exact)
  - native_name — Native name
  - o — Which field to use when ordering the results.
  - organization_group_name — Organization group name
  - organization_group_uuid — Organization group UUID
  - owned_by_current_user — Return a list of customers where current user is owner.
  - query — Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
  - registration_code
  - slug — Slug
  - year — Filter by year.

### financial_reports_count
HEAD /api/financial-reports/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (21):
  - abbreviation — Abbreviation
  - accounting_is_running — Filter by whether accounting is running.
  - agreement_number
  - archived
  - backend_id
  - contact_details — Contact details
  - current_user_has_project_create_permission — Return a list of customers where current user has project create permission.
  - current_user_has_role — Multiple values may be separated by commas.
  - customer_uuid — Filter by customer UUID.
  - month — Filter by month.
  - name — Name
  - name_exact — Name (exact)
  - native_name — Native name
  - o — Which field to use when ordering the results.
  - organization_group_name — Organization group name
  - organization_group_uuid — Organization group UUID
  - owned_by_current_user — Return a list of customers where current user is owner.
  - query — Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
  - registration_code
  - slug — Slug
  - year — Filter by year.

### financial_reports_retrieve
GET /api/financial-reports/{uuid}/
Path parameters:
  - uuid

============================================================
## freeipa-profiles  (module: waldur_api_client.api.freeipa_profiles)
============================================================

### freeipa_profiles_list
GET /api/freeipa-profiles/
Query parameters (2):
  - query — Filter by username, user UUID, first name or last name
  - user

### freeipa_profiles_count
HEAD /api/freeipa-profiles/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - query — Filter by username, user UUID, first name or last name
  - user

### freeipa_profiles_create
POST /api/freeipa-profiles/
Request body: yes

### freeipa_profiles_retrieve
GET /api/freeipa-profiles/{uuid}/
Path parameters:
  - uuid

### freeipa_profiles_update
PUT /api/freeipa-profiles/{uuid}/
Path parameters:
  - uuid
Request body: yes

### freeipa_profiles_partial_update
PATCH /api/freeipa-profiles/{uuid}/
Path parameters:
  - uuid

### freeipa_profiles_update_ssh_keys
POST /api/freeipa-profiles/{uuid}/update_ssh_keys/
Summary: Update SSH keys for profile
Description: Update SSH keys for profile.
Path parameters:
  - uuid

============================================================
## google-auth  (module: waldur_api_client.api.google_auth)
============================================================

### google_auth_list
GET /api/google-auth/
Query parameters (2):
  - field
  - has_credentials — has_credentials

### google_auth_count
HEAD /api/google-auth/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - has_credentials — has_credentials

### google_auth_callback_retrieve
GET /api/google-auth/callback/
Summary: Callback endpoint for Google authorization
Description: Callback endpoint for Google authorization.
Query parameters (2):
  - code (required) — Authorization code
  - state (required) — Service provider UUID

### google_auth_callback_count
HEAD /api/google-auth/callback/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - code (required) — Authorization code
  - state (required) — Service provider UUID

### google_auth_retrieve
GET /api/google-auth/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### google_auth_authorize_retrieve
GET /api/google-auth/{uuid}/authorize/
Path parameters:
  - uuid

============================================================
## hooks  (module: waldur_api_client.api.hooks)
============================================================

### hooks_list
GET /api/hooks/
Query parameters (7):
  - author_email
  - author_fullname — User full name contains
  - author_username
  - author_uuid
  - is_active
  - last_published
  - query — Filter by author name, username and email

### hooks_count
HEAD /api/hooks/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (7):
  - author_email
  - author_fullname — User full name contains
  - author_username
  - author_uuid
  - is_active
  - last_published
  - query — Filter by author name, username and email

============================================================
## hooks-email  (module: waldur_api_client.api.hooks_email)
============================================================

### hooks_email_list
GET /api/hooks-email/
Query parameters (8):
  - author_email
  - author_fullname — User full name contains
  - author_username
  - author_uuid
  - email
  - is_active
  - last_published
  - query — Filter by author name, username and email

### hooks_email_count
HEAD /api/hooks-email/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - author_email
  - author_fullname — User full name contains
  - author_username
  - author_uuid
  - email
  - is_active
  - last_published
  - query — Filter by author name, username and email

### hooks_email_create
POST /api/hooks-email/
Request body: yes

### hooks_email_retrieve
GET /api/hooks-email/{uuid}/
Path parameters:
  - uuid

### hooks_email_update
PUT /api/hooks-email/{uuid}/
Path parameters:
  - uuid
Request body: yes

### hooks_email_partial_update
PATCH /api/hooks-email/{uuid}/
Path parameters:
  - uuid
Request body: yes

### hooks_email_destroy
DELETE /api/hooks-email/{uuid}/
Path parameters:
  - uuid

============================================================
## hooks-web  (module: waldur_api_client.api.hooks_web)
============================================================

### hooks_web_list
GET /api/hooks-web/
Query parameters (9):
  - author_email
  - author_fullname — User full name contains
  - author_username
  - author_uuid
  - content_type
  - destination_url
  - is_active
  - last_published
  - query — Filter by author name, username and email

### hooks_web_count
HEAD /api/hooks-web/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - author_email
  - author_fullname — User full name contains
  - author_username
  - author_uuid
  - content_type
  - destination_url
  - is_active
  - last_published
  - query — Filter by author name, username and email

### hooks_web_create
POST /api/hooks-web/
Summary: When hook is activated, POST request is issued against destination URL with the following data:
Description: When hook is activated, POST request is issued against destination URL with the following data:

.. code-block:: javascript

    {
        "timestamp": "2015-07-14T12:12:56.000000",
        "message": "Customer ABC LLC has been updated.",
        "type": "customer_update_succeeded",
        "cont...
Request body: yes

### hooks_web_retrieve
GET /api/hooks-web/{uuid}/
Path parameters:
  - uuid

### hooks_web_update
PUT /api/hooks-web/{uuid}/
Path parameters:
  - uuid
Request body: yes

### hooks_web_partial_update
PATCH /api/hooks-web/{uuid}/
Path parameters:
  - uuid
Request body: yes

### hooks_web_destroy
DELETE /api/hooks-web/{uuid}/
Path parameters:
  - uuid

============================================================
## identity-bridge  (module: waldur_api_client.api.identity_bridge)
============================================================

### identity_bridge
POST /api/identity-bridge/
Summary: Push user attributes from an ISD
Description: Allows Identity Service Domains (ISDs) to push user attributes to Waldur. Creates or updates a user based on username (CUID). Requires FEDERATED_IDENTITY_SYNC_ENABLED to be True. Caller must be staff or an identity manager with the declared source in managed_isds.
Request body: yes

### identity_bridge_allowed_fields_retrieve
GET /api/identity-bridge/allowed-fields/
Summary: Get allowed Identity Bridge fields
Description: Returns the list of user attribute fields that the Identity Bridge currently accepts. Useful for clients to pre-filter payloads. Requires staff or identity manager permissions.

### identity_bridge_remove
POST /api/identity-bridge/remove/
Summary: Remove a user from an ISD
Description: Signals that a user has been removed from an ISD. Removes the source from active_isds, clears attributes owned by that source, and deactivates the user if no ISDs remain (configurable via FEDERATED_IDENTITY_DEACTIVATION_POLICY). Requires FEDERATED_IDENTITY_SYNC_ENABLED to be True. Caller must be ...
Request body: yes

### identity_bridge_stats_retrieve
GET /api/identity-bridge/stats/
Summary: Get Identity Bridge statistics
Description: Returns system-wide statistics about the Identity Bridge: feature configuration, per-ISD user counts, stale attribute detection, and total federated user counts. Staff only.

============================================================
## identity-providers  (module: waldur_api_client.api.identity_providers)
============================================================

### identity_providers_list
GET /api/identity-providers/

### identity_providers_count
HEAD /api/identity-providers/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### identity_providers_create
POST /api/identity-providers/
Request body: yes

### identity_providers_discover_metadata
POST /api/identity-providers/discover_metadata/
Summary: Discover OIDC provider metadata
Description: Fetches OIDC discovery metadata from the provider and returns supported claims, scopes, and suggested mappings to Waldur User fields. Use this to configure attribute_mapping when setting up a new identity provider.
Request body: yes

### identity_providers_generate_mapping
POST /api/identity-providers/generate-mapping/
Summary: Generate default attribute mapping
Description: Generates a suggested attribute_mapping configuration based on the claims supported by an OIDC provider. This can be used as a starting point when creating a new identity provider.
Request body: yes

### identity_providers_retrieve
GET /api/identity-providers/{provider}/
Path parameters:
  - provider

### identity_providers_update
PUT /api/identity-providers/{provider}/
Path parameters:
  - provider
Request body: yes

### identity_providers_partial_update
PATCH /api/identity-providers/{provider}/
Path parameters:
  - provider
Request body: yes

### identity_providers_destroy
DELETE /api/identity-providers/{provider}/
Path parameters:
  - provider

============================================================
## invoice  (module: waldur_api_client.api.invoice)
============================================================

### invoice_send_financial_report_by_mail
POST /api/invoice/send-financial-report-by-mail/
Request body: yes

============================================================
## invoice-items  (module: waldur_api_client.api.invoice_items)
============================================================

### invoice_items_list
GET /api/invoice-items/
Query parameters (9):
  - credit_uuid
  - customer_uuid
  - month
  - offering_uuid
  - project_uuid
  - resource_uuid
  - start_month — Start month
  - start_year — Start year
  - year

### invoice_items_count
HEAD /api/invoice-items/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - credit_uuid
  - customer_uuid
  - month
  - offering_uuid
  - project_uuid
  - resource_uuid
  - start_month — Start month
  - start_year — Start year
  - year

### invoice_items_costs_list
GET /api/invoice-items/costs/
Summary: Get costs breakdown for a project by year and month
Description: Get costs breakdown for a project by year and month.
Query parameters (1):
  - project_uuid — UUID of the project for which statistics should be calculated.

### invoice_items_costs_count
HEAD /api/invoice-items/costs/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - project_uuid — UUID of the project for which statistics should be calculated.

### invoice_items_customer_costs_for_period_retrieve
GET /api/invoice-items/customer_costs_for_period/
Query parameters (2):
  - customer_uuid — UUID of the project for which statistics should be calculated.
  - period — Period for which statistics should be calculated.

### invoice_items_customer_costs_for_period_count
HEAD /api/invoice-items/customer_costs_for_period/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - customer_uuid — UUID of the project for which statistics should be calculated.
  - period — Period for which statistics should be calculated.

### invoice_items_project_costs_for_period_retrieve
GET /api/invoice-items/project_costs_for_period/
Summary: Get resource cost breakdown for a project over a specified period
Description: Get resource cost breakdown for a project over a specified period.
Query parameters (2):
  - period — Period for which statistics should be calculated (1, 3 or 12 months).
  - project_uuid — UUID of the project for which statistics should be calculated.

### invoice_items_project_costs_for_period_count
HEAD /api/invoice-items/project_costs_for_period/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - period — Period for which statistics should be calculated (1, 3 or 12 months).
  - project_uuid — UUID of the project for which statistics should be calculated.

### invoice_items_total_price_retrieve
GET /api/invoice-items/total_price/
Summary: Calculate total price for filtered invoice items
Description: Calculate total price for filtered invoice items.
Query parameters (9):
  - credit_uuid
  - customer_uuid
  - month
  - offering_uuid
  - project_uuid
  - resource_uuid
  - start_month — Start month
  - start_year — Start year
  - year

### invoice_items_total_price_count
HEAD /api/invoice-items/total_price/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - credit_uuid
  - customer_uuid
  - month
  - offering_uuid
  - project_uuid
  - resource_uuid
  - start_month — Start month
  - start_year — Start year
  - year

### invoice_items_retrieve
GET /api/invoice-items/{uuid}/
Path parameters:
  - uuid

### invoice_items_update
PUT /api/invoice-items/{uuid}/
Path parameters:
  - uuid
Request body: yes

### invoice_items_partial_update
PATCH /api/invoice-items/{uuid}/
Path parameters:
  - uuid
Request body: yes

### invoice_items_destroy
DELETE /api/invoice-items/{uuid}/
Path parameters:
  - uuid

### invoice_items_consumptions_list
GET /api/invoice-items/{uuid}/consumptions/
Path parameters:
  - uuid
Query parameters (9):
  - credit_uuid
  - customer_uuid
  - month
  - offering_uuid
  - project_uuid
  - resource_uuid
  - start_month — Start month
  - start_year — Start year
  - year

### invoice_items_create_compensation
POST /api/invoice-items/{uuid}/create_compensation/
Summary: Create compensation invoice item for selected invoice item
Description: Create compensation invoice item for selected invoice item.
Path parameters:
  - uuid
Request body: yes

### invoice_items_migrate_to
POST /api/invoice-items/{uuid}/migrate_to/
Summary: Move invoice item from one invoice to another one
Description: Move invoice item from one invoice to another one.
Path parameters:
  - uuid
Request body: yes

============================================================
## invoices  (module: waldur_api_client.api.invoices)
============================================================

### invoices_list
GET /api/invoices/
Query parameters (11):
  - accounting_is_running — Filter by whether accounting is running.
  - created
  - customer
  - customer_uuid
  - end_date
  - field
  - month
  - o — Ordering
  - start_date
  - state
  - year

### invoices_count
HEAD /api/invoices/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (10):
  - accounting_is_running — Filter by whether accounting is running.
  - created
  - customer
  - customer_uuid
  - end_date
  - month
  - o — Ordering
  - start_date
  - state
  - year

### invoices_growth_retrieve
GET /api/invoices/growth/
Summary: Analyze invoice trends over time by comparing monthly totals for major customers versus others over the past year
Description: Analyze invoice trends over time by comparing monthly totals for major customers versus others over the past year.
Query parameters (3):
  - accounting_is_running
  - accounting_mode
  - customers_count

### invoices_growth_count
HEAD /api/invoices/growth/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - accounting_is_running
  - accounting_mode
  - customers_count

### invoices_import_usage
POST /api/invoices/import_usage/
Summary: Import usage data
Description: Import component usage items as JSON data for multiple customers. Creates invoice items for the specified billing period. Items are deduplicated by name, customer, and billing period to prevent duplicates.
Request body: yes

### invoices_retrieve
GET /api/invoices/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### invoices_history_list
GET /api/invoices/{uuid}/history/
Summary: Get version history
Description: Returns the version history for this object. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (12):
  - accounting_is_running — Filter by whether accounting is running.
  - created
  - created_after — Filter versions created after this timestamp (ISO 8601)
  - created_before — Filter versions created before this timestamp (ISO 8601)
  - customer
  - customer_uuid
  - end_date
  - month
  - o — Ordering
  - start_date
  - state
  - year

### invoices_history_at_retrieve
GET /api/invoices/{uuid}/history/at/
Summary: Get object state at a specific timestamp
Description: Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (1):
  - timestamp (required) — ISO 8601 timestamp to query the object state at

### invoices_items_retrieve
GET /api/invoices/{uuid}/items/
Summary: Get invoice items
Description: Retrieve a list of invoice items for the specified invoice.
Path parameters:
  - uuid
Query parameters (6):
  - conceal_compensation_items — Conceal compensation items
  - o — Order results by field
  - offering_uuid
  - project_uuid
  - provider_uuid
  - query

### invoices_paid
POST /api/invoices/{uuid}/paid/
Summary: Mark invoice as paid and optionally create payment record with proof of payment
Description: Mark invoice as paid and optionally create payment record with proof of payment.
Path parameters:
  - uuid
Request body: yes

### invoices_send_notification
POST /api/invoices/{uuid}/send_notification/
Summary: Send invoice notification
Description: Schedule sending of a notification for the specified invoice.
Path parameters:
  - uuid

### invoices_set_backend_id
POST /api/invoices/{uuid}/set_backend_id/
Summary: Set backend ID for invoice
Description: Set backend ID for invoice.
Path parameters:
  - uuid
Request body: yes

### invoices_set_payment_url
POST /api/invoices/{uuid}/set_payment_url/
Summary: Set payment URL for invoice
Description: Set payment URL for invoice.
Path parameters:
  - uuid
Request body: yes

### invoices_set_reference_number
POST /api/invoices/{uuid}/set_reference_number/
Summary: Set reference number for invoice
Description: Set reference number for invoice.
Path parameters:
  - uuid
Request body: yes

### invoices_stats_list
GET /api/invoices/{uuid}/stats/
Summary: Spendings grouped by offerings and filtered by provider
Description: Spendings grouped by offerings and filtered by provider.
Path parameters:
  - uuid
Query parameters (11):
  - accounting_is_running — Filter by whether accounting is running.
  - created
  - customer
  - customer_uuid
  - end_date
  - month
  - o — Ordering
  - provider_uuid
  - start_date
  - state
  - year

============================================================
## keycloak-groups  (module: waldur_api_client.api.keycloak_groups)
============================================================

### keycloak_groups_list
GET /api/keycloak-groups/
Query parameters (3):
  - role
  - scope_type
  - scope_uuid

### keycloak_groups_count
HEAD /api/keycloak-groups/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - role
  - scope_type
  - scope_uuid

### keycloak_groups_retrieve
GET /api/keycloak-groups/{uuid}/
Path parameters:
  - uuid

============================================================
## keycloak-user-group-memberships  (module: waldur_api_client.api.keycloak_user_group_memberships)
============================================================

### keycloak_user_group_memberships_list
GET /api/keycloak-user-group-memberships/
Query parameters (9):
  - email
  - first_name
  - group_uuid
  - last_name
  - role_uuid
  - scope_type
  - scope_uuid
  - state
  - username

### keycloak_user_group_memberships_count
HEAD /api/keycloak-user-group-memberships/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - email
  - first_name
  - group_uuid
  - last_name
  - role_uuid
  - scope_type
  - scope_uuid
  - state
  - username

### keycloak_user_group_memberships_create
POST /api/keycloak-user-group-memberships/
Request body: yes

### keycloak_user_group_memberships_retrieve
GET /api/keycloak-user-group-memberships/{uuid}/
Path parameters:
  - uuid

### keycloak_user_group_memberships_update
PUT /api/keycloak-user-group-memberships/{uuid}/
Path parameters:
  - uuid
Request body: yes

### keycloak_user_group_memberships_partial_update
PATCH /api/keycloak-user-group-memberships/{uuid}/
Path parameters:
  - uuid
Request body: yes

### keycloak_user_group_memberships_destroy
DELETE /api/keycloak-user-group-memberships/{uuid}/
Path parameters:
  - uuid

============================================================
## keys  (module: waldur_api_client.api.keys)
============================================================

### keys_list
GET /api/keys/
Query parameters (13):
  - created — Created after
  - created_before — Created before
  - field
  - fingerprint_md5
  - fingerprint_sha256
  - fingerprint_sha512
  - is_shared
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - user_uuid — User UUID

### keys_count
HEAD /api/keys/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (12):
  - created — Created after
  - created_before — Created before
  - fingerprint_md5
  - fingerprint_sha256
  - fingerprint_sha512
  - is_shared
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - user_uuid — User UUID

### keys_create
POST /api/keys/
Request body: yes

### keys_retrieve
GET /api/keys/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### keys_destroy
DELETE /api/keys/{uuid}/
Path parameters:
  - uuid

### keys_history_list
GET /api/keys/{uuid}/history/
Summary: Get version history
Description: Returns the version history for this object. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (13):
  - created — Created after
  - created_after — Filter versions created after this timestamp (ISO 8601)
  - created_before — Filter versions created before this timestamp (ISO 8601)
  - fingerprint_md5
  - fingerprint_sha256
  - fingerprint_sha512
  - is_shared
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - user_uuid — User UUID

### keys_history_at_retrieve
GET /api/keys/{uuid}/history/at/
Summary: Get object state at a specific timestamp
Description: Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (1):
  - timestamp (required) — ISO 8601 timestamp to query the object state at

============================================================
## lexis-links  (module: waldur_api_client.api.lexis_links)
============================================================

### lexis_links_list
GET /api/lexis-links/
Query parameters (5):
  - customer_uuid
  - project_uuid
  - query — Filter by robot account username or type
  - resource_uuid
  - uuid

### lexis_links_count
HEAD /api/lexis-links/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - customer_uuid
  - project_uuid
  - query — Filter by robot account username or type
  - resource_uuid
  - uuid

### lexis_links_create
POST /api/lexis-links/
Request body: yes

### lexis_links_retrieve
GET /api/lexis-links/{uuid}/
Path parameters:
  - uuid

### lexis_links_update
PUT /api/lexis-links/{uuid}/
Path parameters:
  - uuid
Request body: yes

### lexis_links_partial_update
PATCH /api/lexis-links/{uuid}/
Path parameters:
  - uuid
Request body: yes

### lexis_links_destroy
DELETE /api/lexis-links/{uuid}/
Path parameters:
  - uuid

============================================================
## maintenance-announcement-offerings  (module: waldur_api_client.api.maintenance_announcement_offerings)
============================================================

### maintenance_announcement_offerings_list
GET /api/maintenance-announcement-offerings/
Summary: List affected offerings for maintenance
Description: Returns a paginated list of offerings affected by maintenance announcements.

### maintenance_announcement_offerings_count
HEAD /api/maintenance-announcement-offerings/
Summary: List affected offerings for maintenance
Description: Get number of items in the collection matching the request parameters.

### maintenance_announcement_offerings_create
POST /api/maintenance-announcement-offerings/
Summary: Link an offering to a maintenance announcement
Description: Creates a new association between an offering and a maintenance announcement, specifying the expected impact.
Request body: yes

### maintenance_announcement_offerings_retrieve
GET /api/maintenance-announcement-offerings/{uuid}/
Summary: Retrieve an affected offering link
Description: Returns the details of a specific link between a maintenance announcement and an offering, including the impact level and description.
Path parameters:
  - uuid

### maintenance_announcement_offerings_update
PUT /api/maintenance-announcement-offerings/{uuid}/
Summary: Update an affected offering link
Description: Updates the impact level or description for an offering linked to a maintenance announcement.
Path parameters:
  - uuid
Request body: yes

### maintenance_announcement_offerings_partial_update
PATCH /api/maintenance-announcement-offerings/{uuid}/
Summary: Partially update an affected offering link
Description: Partially updates the impact level or description for an offering linked to a maintenance announcement.
Path parameters:
  - uuid
Request body: yes

### maintenance_announcement_offerings_destroy
DELETE /api/maintenance-announcement-offerings/{uuid}/
Summary: Unlink an offering from a maintenance announcement
Description: Removes the association between an offering and a maintenance announcement.
Path parameters:
  - uuid

============================================================
## maintenance-announcement-template-offerings  (module: waldur_api_client.api.maintenance_announcement_template_offerings)
============================================================

### maintenance_announcement_template_offerings_list
GET /api/maintenance-announcement-template-offerings/
Summary: List affected offering templates
Description: Returns a paginated list of associations between maintenance announcement templates and offerings.
Query parameters (5):
  - impact_level — Impact level
  - maintenance_template_uuid — Maintenance template UUID
  - o — Ordering
  - offering_uuid — Offering UUID
  - service_provider_uuid — Service provider UUID

### maintenance_announcement_template_offerings_count
HEAD /api/maintenance-announcement-template-offerings/
Summary: List affected offering templates
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - impact_level — Impact level
  - maintenance_template_uuid — Maintenance template UUID
  - o — Ordering
  - offering_uuid — Offering UUID
  - service_provider_uuid — Service provider UUID

### maintenance_announcement_template_offerings_create
POST /api/maintenance-announcement-template-offerings/
Summary: Link an offering to a maintenance template
Description: Creates a reusable association between an offering and a maintenance announcement template, specifying a default impact level and description.
Request body: yes

### maintenance_announcement_template_offerings_retrieve
GET /api/maintenance-announcement-template-offerings/{uuid}/
Summary: Retrieve an affected offering template link
Description: Returns the details of a specific link between a maintenance announcement template and an offering.
Path parameters:
  - uuid

### maintenance_announcement_template_offerings_update
PUT /api/maintenance-announcement-template-offerings/{uuid}/
Summary: Update an affected offering template link
Description: Updates the default impact level or description for an offering linked to a maintenance template.
Path parameters:
  - uuid
Request body: yes

### maintenance_announcement_template_offerings_partial_update
PATCH /api/maintenance-announcement-template-offerings/{uuid}/
Summary: Partially update an affected offering template link
Description: Partially updates the default impact level or description for an offering linked to a maintenance template.
Path parameters:
  - uuid
Request body: yes

### maintenance_announcement_template_offerings_destroy
DELETE /api/maintenance-announcement-template-offerings/{uuid}/
Summary: Unlink an offering from a maintenance template
Description: Removes the association between an offering and a maintenance announcement template.
Path parameters:
  - uuid

============================================================
## maintenance-announcements  (module: waldur_api_client.api.maintenance_announcements)
============================================================

### maintenance_announcements_list
GET /api/maintenance-announcements/
Summary: List maintenance announcements
Description: Returns a paginated list of maintenance announcements.
Query parameters (9):
  - maintenance_type — Maintenance type
  - o — Ordering
  - scheduled_end_after — Scheduled end after
  - scheduled_end_before — Scheduled end before
  - scheduled_start_after — Scheduled start after
  - scheduled_start_before — Scheduled start before
  - service_provider_uuid — Service provider UUID
  - state — Maintenance state
  - timing_bucket — Timing bucket (comma-separated: on_time, late_start, overrun, early, pending)

### maintenance_announcements_count
HEAD /api/maintenance-announcements/
Summary: List maintenance announcements
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - maintenance_type — Maintenance type
  - o — Ordering
  - scheduled_end_after — Scheduled end after
  - scheduled_end_before — Scheduled end before
  - scheduled_start_after — Scheduled start after
  - scheduled_start_before — Scheduled start before
  - service_provider_uuid — Service provider UUID
  - state — Maintenance state
  - timing_bucket — Timing bucket (comma-separated: on_time, late_start, overrun, early, pending)

### maintenance_announcements_create
POST /api/maintenance-announcements/
Summary: Create a maintenance announcement
Description: Creates a new maintenance announcement in the 'Draft' state.
Request body: yes

### maintenance_announcements_maintenance_stats_retrieve
GET /api/maintenance-announcements/maintenance_stats/
Summary: Get maintenance announcement statistics
Description: Returns comprehensive statistics for maintenance announcements including counts by state, type, impact level, and daily breakdown.
Query parameters (3):
  - end — End date in YYYY-MM-DD format. Defaults to 30 days in the future.
  - provider_uuid — Filter by service provider UUID.
  - start — Start date in YYYY-MM-DD format. Defaults to 90 days ago.

### maintenance_announcements_maintenance_stats_count
HEAD /api/maintenance-announcements/maintenance_stats/
Summary: Get maintenance announcement statistics
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - end — End date in YYYY-MM-DD format. Defaults to 30 days in the future.
  - provider_uuid — Filter by service provider UUID.
  - start — Start date in YYYY-MM-DD format. Defaults to 90 days ago.

### maintenance_announcements_retrieve
GET /api/maintenance-announcements/{uuid}/
Summary: Retrieve a maintenance announcement
Description: Returns the details of a specific maintenance announcement.
Path parameters:
  - uuid

### maintenance_announcements_update
PUT /api/maintenance-announcements/{uuid}/
Summary: Update a maintenance announcement
Description: Updates an existing maintenance announcement.
Path parameters:
  - uuid
Request body: yes

### maintenance_announcements_partial_update
PATCH /api/maintenance-announcements/{uuid}/
Summary: Partially update a maintenance announcement
Description: Partially updates an existing maintenance announcement.
Path parameters:
  - uuid
Request body: yes

### maintenance_announcements_destroy
DELETE /api/maintenance-announcements/{uuid}/
Summary: Delete a maintenance announcement
Description: Deletes a maintenance announcement.
Path parameters:
  - uuid

### maintenance_announcements_cancel_maintenance
POST /api/maintenance-announcements/{uuid}/cancel_maintenance/
Summary: Cancel the maintenance announcement
Description: Transitions a 'Draft' or 'Scheduled' maintenance announcement to 'Cancelled'.
Path parameters:
  - uuid

### maintenance_announcements_complete_maintenance
POST /api/maintenance-announcements/{uuid}/complete_maintenance/
Summary: Complete the maintenance announcement
Description: Transitions an 'In progress' maintenance announcement to 'Completed', indicating that the maintenance work has finished.
Path parameters:
  - uuid

### maintenance_announcements_schedule
POST /api/maintenance-announcements/{uuid}/schedule/
Summary: Schedule/publish the maintenance announcement
Description: Transitions a 'Draft' maintenance announcement to the 'Scheduled' state, making it publicly visible.
Path parameters:
  - uuid

### maintenance_announcements_start_maintenance
POST /api/maintenance-announcements/{uuid}/start_maintenance/
Summary: Start the maintenance announcement
Description: Transitions a 'Scheduled' maintenance announcement to 'In progress', indicating that the maintenance work has begun.
Path parameters:
  - uuid

### maintenance_announcements_unschedule
POST /api/maintenance-announcements/{uuid}/unschedule/
Summary: Unschedule/unpublish the maintenance announcement
Description: Transitions a 'Scheduled' maintenance announcement back to the 'Draft' state, hiding it from public view.
Path parameters:
  - uuid

============================================================
## maintenance-announcements-template  (module: waldur_api_client.api.maintenance_announcements_template)
============================================================

### maintenance_announcements_template_list
GET /api/maintenance-announcements-template/
Summary: List maintenance announcement templates
Description: Returns a paginated list of reusable templates for maintenance announcements.
Query parameters (3):
  - maintenance_type — Maintenance type
  - o — Ordering
  - service_provider_uuid — Service provider UUID

### maintenance_announcements_template_count
HEAD /api/maintenance-announcements-template/
Summary: List maintenance announcement templates
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - maintenance_type — Maintenance type
  - o — Ordering
  - service_provider_uuid — Service provider UUID

### maintenance_announcements_template_create
POST /api/maintenance-announcements-template/
Summary: Create a maintenance announcement template
Description: Creates a new reusable template for maintenance announcements, including a default message and type.
Request body: yes

### maintenance_announcements_template_retrieve
GET /api/maintenance-announcements-template/{uuid}/
Summary: Retrieve a maintenance announcement template
Description: Returns the details of a specific maintenance announcement template.
Path parameters:
  - uuid

### maintenance_announcements_template_update
PUT /api/maintenance-announcements-template/{uuid}/
Summary: Update a maintenance announcement template
Description: Updates an existing maintenance announcement template.
Path parameters:
  - uuid
Request body: yes

### maintenance_announcements_template_partial_update
PATCH /api/maintenance-announcements-template/{uuid}/
Summary: Partially update a maintenance announcement template
Description: Partially updates an existing maintenance announcement template.
Path parameters:
  - uuid
Request body: yes

### maintenance_announcements_template_destroy
DELETE /api/maintenance-announcements-template/{uuid}/
Summary: Delete a maintenance announcement template
Description: Deletes a maintenance announcement template.
Path parameters:
  - uuid

============================================================
## managed-rancher-cluster-resources  (module: waldur_api_client.api.managed_rancher_cluster_resources)
============================================================

### managed_rancher_cluster_resources_list
GET /api/managed-rancher-cluster-resources/
Query parameters (1):
  - field

### managed_rancher_cluster_resources_count
HEAD /api/managed-rancher-cluster-resources/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### managed_rancher_cluster_resources_retrieve
GET /api/managed-rancher-cluster-resources/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### managed_rancher_cluster_resources_add_node
POST /api/managed-rancher-cluster-resources/{uuid}/add_node/
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-article-code-update  (module: waldur_api_client.api.marketplace_article_code_update)
============================================================

### marketplace_article_code_update_apply
POST /api/marketplace-article-code-update/apply/
Summary: Apply article code replacements
Request body: yes

### marketplace_article_code_update_preview
POST /api/marketplace-article-code-update/preview/
Summary: Preview article code replacements
Request body: yes

============================================================
## marketplace-attribute-options  (module: waldur_api_client.api.marketplace_attribute_options)
============================================================

### marketplace_attribute_options_list
GET /api/marketplace-attribute-options/
Summary: List attribute options
Description: Returns a paginated list of options for choice-type attributes. Filter by attribute (URL). Default option is determined by attribute.default.
Query parameters (1):
  - attribute — Attribute URL

### marketplace_attribute_options_count
HEAD /api/marketplace-attribute-options/
Summary: List attribute options
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - attribute — Attribute URL

### marketplace_attribute_options_create
POST /api/marketplace-attribute-options/
Summary: Create an attribute option
Description: Creates a new option for a choice-type attribute. Requires staff permissions.
Request body: yes

### marketplace_attribute_options_retrieve
GET /api/marketplace-attribute-options/{uuid}/
Summary: Retrieve an attribute option
Description: Returns the details of a specific attribute option.
Path parameters:
  - uuid

### marketplace_attribute_options_update
PUT /api/marketplace-attribute-options/{uuid}/
Summary: Update an attribute option
Description: Updates an existing attribute option. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_attribute_options_partial_update
PATCH /api/marketplace-attribute-options/{uuid}/
Summary: Partially update an attribute option
Description: Partially updates an existing attribute option. To set the default option, PATCH the attribute with default=<option_key>. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_attribute_options_destroy
DELETE /api/marketplace-attribute-options/{uuid}/
Summary: Delete an attribute option
Description: Deletes an attribute option. Requires staff permissions.
Path parameters:
  - uuid

============================================================
## marketplace-attributes  (module: waldur_api_client.api.marketplace_attributes)
============================================================

### marketplace_attributes_list
GET /api/marketplace-attributes/
Summary: List attributes
Description: Returns a paginated list of all attributes. Attributes define form fields within section. Filter by section (URL).
Query parameters (1):
  - section — Section URL

### marketplace_attributes_count
HEAD /api/marketplace-attributes/
Summary: List attributes
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - section — Section URL

### marketplace_attributes_create
POST /api/marketplace-attributes/
Summary: Create an attribute
Description: Creates a new attribute within a section. Requires staff permissions.
Request body: yes

### marketplace_attributes_retrieve
GET /api/marketplace-attributes/{uuid}/
Summary: Retrieve an attribute
Description: Returns the details of a specific attribute, identified by its UUID.
Path parameters:
  - uuid

### marketplace_attributes_update
PUT /api/marketplace-attributes/{uuid}/
Summary: Update an attribute
Description: Updates an existing attribute. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_attributes_partial_update
PATCH /api/marketplace-attributes/{uuid}/
Summary: Partially update an attribute
Description: Partially updates an existing attribute. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_attributes_destroy
DELETE /api/marketplace-attributes/{uuid}/
Summary: Delete an attribute
Description: Deletes an attribute. Requires staff permissions.
Path parameters:
  - uuid

============================================================
## marketplace-bookings  (module: waldur_api_client.api.marketplace_bookings)
============================================================

### marketplace_bookings_list
GET /api/marketplace-bookings/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-categories  (module: waldur_api_client.api.marketplace_categories)
============================================================

### marketplace_categories_list
GET /api/marketplace-categories/
Summary: List categories
Description: Returns a paginated list of marketplace categories.
Query parameters (10):
  - customer_uuid — Customer UUID
  - customers_offerings_state — Customers offerings state
  - field
  - group_uuid — Category group UUID
  - has_shared — Has shared
  - o — Which field to use when ordering the results.
  - offering_name — Offering name contains
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - title — Title contains

### marketplace_categories_count
HEAD /api/marketplace-categories/
Summary: List categories
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - customer_uuid — Customer UUID
  - customers_offerings_state — Customers offerings state
  - group_uuid — Category group UUID
  - has_shared — Has shared
  - o — Which field to use when ordering the results.
  - offering_name — Offering name contains
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - title — Title contains

### marketplace_categories_create
POST /api/marketplace-categories/
Summary: Create a category
Description: Creates a new marketplace category. Requires staff permissions.
Request body: yes

### marketplace_categories_retrieve
GET /api/marketplace-categories/{uuid}/
Summary: Retrieve a category
Description: Returns details of a specific marketplace category.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_categories_update
PUT /api/marketplace-categories/{uuid}/
Summary: Update a category
Description: Updates an existing marketplace category. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_categories_partial_update
PATCH /api/marketplace-categories/{uuid}/
Summary: Partially update a category
Description: Partially updates an existing marketplace category. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_categories_destroy
DELETE /api/marketplace-categories/{uuid}/
Summary: Delete a category
Description: Deletes a marketplace category. Requires staff permissions.
Path parameters:
  - uuid

============================================================
## marketplace-category-columns  (module: waldur_api_client.api.marketplace_category_columns)
============================================================

### marketplace_category_columns_list
GET /api/marketplace-category-columns/
Summary: List category columns
Description: Returns a paginated list of category columns used for resource table rendering.
Query parameters (2):
  - category_uuid — Category UUID
  - title — Title contains

### marketplace_category_columns_count
HEAD /api/marketplace-category-columns/
Summary: List category columns
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - category_uuid — Category UUID
  - title — Title contains

### marketplace_category_columns_create
POST /api/marketplace-category-columns/
Summary: Create a category column
Description: Creates a new category column. Requires staff permissions.
Request body: yes

### marketplace_category_columns_retrieve
GET /api/marketplace-category-columns/{uuid}/
Summary: Retrieve a category column
Description: Returns details of a specific category column.
Path parameters:
  - uuid

### marketplace_category_columns_update
PUT /api/marketplace-category-columns/{uuid}/
Summary: Update a category column
Description: Updates an existing category column. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_category_columns_partial_update
PATCH /api/marketplace-category-columns/{uuid}/
Summary: Partially update a category column
Description: Partially updates an existing category column. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_category_columns_destroy
DELETE /api/marketplace-category-columns/{uuid}/
Summary: Delete a category column
Description: Deletes a category column. Requires staff permissions.
Path parameters:
  - uuid

============================================================
## marketplace-category-component-usages  (module: waldur_api_client.api.marketplace_category_component_usages)
============================================================

### marketplace_category_component_usages_list
GET /api/marketplace-category-component-usages/
Summary: List aggregated category component usages
Description: Returns a paginated list of aggregated component usages for marketplace categories.
        This data is scoped to either a customer or a project and represents the total usage
        of a component type (e.g., total 'CPU hours' used across all resources of a certain category
        within a pr...
Query parameters (4):
  - date_after — Date after or equal to
  - date_before — Date before or equal to
  - field
  - scope — Filter by scope URL.

### marketplace_category_component_usages_count
HEAD /api/marketplace-category-component-usages/
Summary: List aggregated category component usages
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - date_after — Date after or equal to
  - date_before — Date before or equal to
  - scope — Filter by scope URL.

### marketplace_category_component_usages_retrieve
GET /api/marketplace-category-component-usages/{id}/
Summary: Retrieve an aggregated category component usage record
Description: Returns the details of a single aggregated usage record for a category component, identified by its database ID.
Path parameters:
  - id — A unique integer value identifying this category component usage.
Query parameters (1):
  - field

============================================================
## marketplace-category-components  (module: waldur_api_client.api.marketplace_category_components)
============================================================

### marketplace_category_components_list
GET /api/marketplace-category-components/
Summary: List category components
Description: Returns a paginated list of all components defined at the category level. These act as templates for components in offerings.

### marketplace_category_components_count
HEAD /api/marketplace-category-components/
Summary: List category components
Description: Get number of items in the collection matching the request parameters.

### marketplace_category_components_create
POST /api/marketplace-category-components/
Summary: Create a category component
Description: Creates a new component for a category. Requires staff permissions.
Request body: yes

### marketplace_category_components_retrieve
GET /api/marketplace-category-components/{id}/
Summary: Retrieve a category component
Description: Returns the details of a specific category component, identified by its ID.
Path parameters:
  - id — A unique integer value identifying this category component.

### marketplace_category_components_update
PUT /api/marketplace-category-components/{id}/
Summary: Update a category component
Description: Updates an existing category component. Requires staff permissions.
Path parameters:
  - id — A unique integer value identifying this category component.
Request body: yes

### marketplace_category_components_partial_update
PATCH /api/marketplace-category-components/{id}/
Summary: Partially update a category component
Description: Partially updates an existing category component. Requires staff permissions.
Path parameters:
  - id — A unique integer value identifying this category component.
Request body: yes

### marketplace_category_components_destroy
DELETE /api/marketplace-category-components/{id}/
Summary: Delete a category component
Description: Deletes a category component. Requires staff permissions.
Path parameters:
  - id — A unique integer value identifying this category component.

============================================================
## marketplace-category-groups  (module: waldur_api_client.api.marketplace_category_groups)
============================================================

### marketplace_category_groups_list
GET /api/marketplace-category-groups/
Summary: List category groups
Description: Returns a paginated list of category groups.
Query parameters (2):
  - field
  - title

### marketplace_category_groups_count
HEAD /api/marketplace-category-groups/
Summary: List category groups
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - title

### marketplace_category_groups_create
POST /api/marketplace-category-groups/
Summary: Create a category group
Description: Creates a new category group. Requires staff permissions.
Request body: yes

### marketplace_category_groups_retrieve
GET /api/marketplace-category-groups/{uuid}/
Summary: Retrieve a category group
Description: Returns details of a specific category group.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_category_groups_update
PUT /api/marketplace-category-groups/{uuid}/
Summary: Update a category group
Description: Updates an existing category group. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_category_groups_partial_update
PATCH /api/marketplace-category-groups/{uuid}/
Summary: Partially update a category group
Description: Partially updates an existing category group. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_category_groups_destroy
DELETE /api/marketplace-category-groups/{uuid}/
Summary: Delete a category group
Description: Deletes a category group. Requires staff permissions.
Path parameters:
  - uuid

============================================================
## marketplace-category-help-articles  (module: waldur_api_client.api.marketplace_category_help_articles)
============================================================

### marketplace_category_help_articles_list
GET /api/marketplace-category-help-articles/
Summary: List category help articles
Description: Returns a paginated list of all help articles associated with marketplace categories.

### marketplace_category_help_articles_count
HEAD /api/marketplace-category-help-articles/
Summary: List category help articles
Description: Get number of items in the collection matching the request parameters.

### marketplace_category_help_articles_create
POST /api/marketplace-category-help-articles/
Summary: Create a category help article
Description: Creates a new help article and associates it with one or more categories. Requires staff permissions.
Request body: yes

### marketplace_category_help_articles_retrieve
GET /api/marketplace-category-help-articles/{id}/
Summary: Retrieve a category help article
Description: Returns the details of a specific help article, identified by its ID.
Path parameters:
  - id — A unique integer value identifying this category help article.

### marketplace_category_help_articles_update
PUT /api/marketplace-category-help-articles/{id}/
Summary: Update a category help article
Description: Updates an existing help article. Requires staff permissions.
Path parameters:
  - id — A unique integer value identifying this category help article.
Request body: yes

### marketplace_category_help_articles_partial_update
PATCH /api/marketplace-category-help-articles/{id}/
Summary: Partially update a category help article
Description: Partially updates an existing help article. Requires staff permissions.
Path parameters:
  - id — A unique integer value identifying this category help article.
Request body: yes

### marketplace_category_help_articles_destroy
DELETE /api/marketplace-category-help-articles/{id}/
Summary: Delete a category help article
Description: Deletes a help article. Requires staff permissions.
Path parameters:
  - id — A unique integer value identifying this category help article.

============================================================
## marketplace-chat  (module: waldur_api_client.api.marketplace_chat)
============================================================

### marketplace_chat_click
POST /api/marketplace-chat/click/
Request body: yes

### marketplace_chat_feedback
POST /api/marketplace-chat/feedback/
Request body: yes

### marketplace_chat_stream
POST /api/marketplace-chat/stream/
Summary: Anonymous chat streaming endpoint
Description: Anonymous chat streaming endpoint. Returns NDJSON with one assistant content block per line. Final `m` frame carries input/output token counts.
Request body: yes

============================================================
## marketplace-component-usage-monthly  (module: waldur_api_client.api.marketplace_component_usage_monthly)
============================================================

### marketplace_component_usage_monthly_list
GET /api/marketplace-component-usage-monthly/
Summary: List monthly component usage summaries globally
Description: Returns paginated monthly component usage across all offerings and service providers. Results are automatically filtered by the user's permissions. Defaults to the current month if no time filters ('billing_period', 'start', 'end') are provided.
Query parameters (11):
  - billing_period
  - billing_type
  - component_type
  - customer_uuid
  - end
  - field
  - o — Which field to use when ordering the results.
  - offering_type
  - offering_uuid
  - project_uuid
  - start

### marketplace_component_usage_monthly_count
HEAD /api/marketplace-component-usage-monthly/
Summary: List monthly component usage summaries globally
Description: Get number of items in the collection matching the request parameters.
Query parameters (10):
  - billing_period
  - billing_type
  - component_type
  - customer_uuid
  - end
  - o — Which field to use when ordering the results.
  - offering_type
  - offering_uuid
  - project_uuid
  - start

============================================================
## marketplace-component-usages  (module: waldur_api_client.api.marketplace_component_usages)
============================================================

### marketplace_component_usages_list
GET /api/marketplace-component-usages/
Summary: List component usage records
Description: Returns a paginated list of component usage records for resources. This data is used for billing and usage tracking.
Query parameters (13):
  - billing_period
  - billing_period_month — Billing period month
  - billing_period_year — Billing period year
  - customer_uuid — Customer UUID
  - date_after — Date after or equal to
  - date_before — Date before or equal to
  - field
  - o — Ordering
  - offering_uuid — Offering UUID
  - project_uuid — Project UUID
  - resource — Resource URL
  - resource_uuid — Resource UUID
  - type — Component type

### marketplace_component_usages_count
HEAD /api/marketplace-component-usages/
Summary: List component usage records
Description: Get number of items in the collection matching the request parameters.
Query parameters (12):
  - billing_period
  - billing_period_month — Billing period month
  - billing_period_year — Billing period year
  - customer_uuid — Customer UUID
  - date_after — Date after or equal to
  - date_before — Date before or equal to
  - o — Ordering
  - offering_uuid — Offering UUID
  - project_uuid — Project UUID
  - resource — Resource URL
  - resource_uuid — Resource UUID
  - type — Component type

### marketplace_component_usages_set_usage
POST /api/marketplace-component-usages/set_usage/
Summary: Set component usage for a resource
Description: Allows a service provider to report usage for one or more components of a specific resource.
        This endpoint is typically used by backend systems or agents to submit periodic usage data.

        - If a `plan_period` is provided, the usage is associated with that period.
        - If only a...
Request body: yes

### marketplace_component_usages_retrieve
GET /api/marketplace-component-usages/{uuid}/
Summary: Retrieve a component usage record
Description: Returns the details of a specific component usage record.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_component_usages_set_user_usage
POST /api/marketplace-component-usages/{uuid}/set_user_usage/
Summary: Set user-specific component usage
Description: Allows a service provider to report usage for a specific user associated with a resource's component.
        This is used for detailed, per-user usage tracking within a single resource.

        - If a user-specific usage record already exists for the given component usage, it will be updated.
 ...
Path parameters:
  - uuid
Request body: yes

### marketplace_component_usages_set_user_usages
POST /api/marketplace-component-usages/{uuid}/set_user_usages/
Summary: Bulk set user-specific component usages
Description: Allows a service provider to report usage for multiple users associated with a resource's component
        in a single request. This avoids the need for one API call per user.

        - All usages are processed atomically: if any item fails validation, none are persisted.
        - If a user-sp...
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-component-user-usages  (module: waldur_api_client.api.marketplace_component_user_usages)
============================================================

### marketplace_component_user_usages_list
GET /api/marketplace-component-user-usages/
Summary: List user-specific component usages
Description: Returns a paginated list of component usage records attributed to specific users.
        This provides a granular view of resource consumption, breaking down the total usage of a component
        by individual users.
Query parameters (14):
  - billing_period_month — Billing period month
  - billing_period_year — Billing period year
  - component_usage__billing_period
  - customer_uuid — Customer UUID
  - date_after — Date after or equal to
  - date_before — Date before or equal .google/docsto
  - field
  - o — Ordering
  - offering_uuid — Offering UUID
  - project_uuid — Project UUID
  - resource — Resource URL
  - resource_uuid — Resource UUID
  - type — Component type
  - username — Username contains

### marketplace_component_user_usages_count
HEAD /api/marketplace-component-user-usages/
Summary: List user-specific component usages
Description: Get number of items in the collection matching the request parameters.
Query parameters (13):
  - billing_period_month — Billing period month
  - billing_period_year — Billing period year
  - component_usage__billing_period
  - customer_uuid — Customer UUID
  - date_after — Date after or equal to
  - date_before — Date before or equal .google/docsto
  - o — Ordering
  - offering_uuid — Offering UUID
  - project_uuid — Project UUID
  - resource — Resource URL
  - resource_uuid — Resource UUID
  - type — Component type
  - username — Username contains

### marketplace_component_user_usages_retrieve
GET /api/marketplace-component-user-usages/{uuid}/
Summary: Retrieve a user-specific component usage record
Description: Returns the details of a single user-specific component usage record.
Path parameters:
  - uuid
Query parameters (1):
  - field

============================================================
## marketplace-course-accounts  (module: waldur_api_client.api.marketplace_course_accounts)
============================================================

### marketplace_course_accounts_list
GET /api/marketplace-course-accounts/
Summary: List course accounts
Description: Returns a paginated list of course accounts accessible to the current user.
Query parameters (9):
  - email — Email contains
  - o — Ordering
  - project_end_date_after — Project end date range
  - project_end_date_before — Project end date range
  - project_start_date_after — Project start date range
  - project_start_date_before — Project start date range
  - project_uuid — Project UUID
  - state — Course account state
  - username — Username

### marketplace_course_accounts_count
HEAD /api/marketplace-course-accounts/
Summary: List course accounts
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - email — Email contains
  - o — Ordering
  - project_end_date_after — Project end date range
  - project_end_date_before — Project end date range
  - project_start_date_after — Project start date range
  - project_start_date_before — Project start date range
  - project_uuid — Project UUID
  - state — Course account state
  - username — Username

### marketplace_course_accounts_create
POST /api/marketplace-course-accounts/
Summary: Create a course account
Description: Creates a new temporary course account within a specified course project.
Request body: yes

### marketplace_course_accounts_create_bulk
POST /api/marketplace-course-accounts/create_bulk/
Summary: Bulk create course accounts
Description: Creates multiple course accounts within a specified course project in a single request.
Query parameters (9):
  - email — Email contains
  - o — Ordering
  - project_end_date_after — Project end date range
  - project_end_date_before — Project end date range
  - project_start_date_after — Project start date range
  - project_start_date_before — Project start date range
  - project_uuid — Project UUID
  - state — Course account state
  - username — Username
Request body: yes

### marketplace_course_accounts_retrieve
GET /api/marketplace-course-accounts/{uuid}/
Summary: Retrieve a course account
Description: Returns the details of a specific course account.
Path parameters:
  - uuid

### marketplace_course_accounts_destroy
DELETE /api/marketplace-course-accounts/{uuid}/
Summary: Delete (close) a course account
Description: Deletes a course account, which triggers a 'close' operation in the backend.
Path parameters:
  - uuid

### marketplace_course_accounts_retry
POST /api/marketplace-course-accounts/{uuid}/retry/
Summary: Retry a failed course account
Path parameters:
  - uuid

============================================================
## marketplace-customer-component-usage-policies  (module: waldur_api_client.api.marketplace_customer_component_usage_policies)
============================================================

### marketplace_customer_component_usage_policies_list
GET /api/marketplace-customer-component-usage-policies/
Query parameters (4):
  - customer
  - customer_uuid
  - scope
  - scope_uuid

### marketplace_customer_component_usage_policies_count
HEAD /api/marketplace-customer-component-usage-policies/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - customer
  - customer_uuid
  - scope
  - scope_uuid

### marketplace_customer_component_usage_policies_create
POST /api/marketplace-customer-component-usage-policies/
Request body: yes

### marketplace_customer_component_usage_policies_actions_retrieve
GET /api/marketplace-customer-component-usage-policies/actions/

### marketplace_customer_component_usage_policies_actions_count
HEAD /api/marketplace-customer-component-usage-policies/actions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_customer_component_usage_policies_retrieve
GET /api/marketplace-customer-component-usage-policies/{uuid}/
Path parameters:
  - uuid

### marketplace_customer_component_usage_policies_update
PUT /api/marketplace-customer-component-usage-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_customer_component_usage_policies_partial_update
PATCH /api/marketplace-customer-component-usage-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_customer_component_usage_policies_destroy
DELETE /api/marketplace-customer-component-usage-policies/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-customer-estimated-cost-policies  (module: waldur_api_client.api.marketplace_customer_estimated_cost_policies)
============================================================

### marketplace_customer_estimated_cost_policies_list
GET /api/marketplace-customer-estimated-cost-policies/
Query parameters (4):
  - customer
  - customer_uuid
  - scope
  - scope_uuid

### marketplace_customer_estimated_cost_policies_count
HEAD /api/marketplace-customer-estimated-cost-policies/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - customer
  - customer_uuid
  - scope
  - scope_uuid

### marketplace_customer_estimated_cost_policies_create
POST /api/marketplace-customer-estimated-cost-policies/
Request body: yes

### marketplace_customer_estimated_cost_policies_actions_retrieve
GET /api/marketplace-customer-estimated-cost-policies/actions/

### marketplace_customer_estimated_cost_policies_actions_count
HEAD /api/marketplace-customer-estimated-cost-policies/actions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_customer_estimated_cost_policies_retrieve
GET /api/marketplace-customer-estimated-cost-policies/{uuid}/
Path parameters:
  - uuid

### marketplace_customer_estimated_cost_policies_update
PUT /api/marketplace-customer-estimated-cost-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_customer_estimated_cost_policies_partial_update
PATCH /api/marketplace-customer-estimated-cost-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_customer_estimated_cost_policies_destroy
DELETE /api/marketplace-customer-estimated-cost-policies/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-customer-service-accounts  (module: waldur_api_client.api.marketplace_customer_service_accounts)
============================================================

### marketplace_customer_service_accounts_list
GET /api/marketplace-customer-service-accounts/
Summary: List service accounts
Query parameters (5):
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - email — Email contains
  - state — Service account state
  - username — Username

### marketplace_customer_service_accounts_count
HEAD /api/marketplace-customer-service-accounts/
Summary: List service accounts
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - email — Email contains
  - state — Service account state
  - username — Username

### marketplace_customer_service_accounts_create
POST /api/marketplace-customer-service-accounts/
Summary: Create a customer service account
Description: Creates a new service account scoped to a specific customer (organization). This generates an API key that can be used for automated access to resources across all projects within that customer.
Request body: yes

### marketplace_customer_service_accounts_retrieve
GET /api/marketplace-customer-service-accounts/{uuid}/
Summary: Retrieve a service account
Path parameters:
  - uuid

### marketplace_customer_service_accounts_update
PUT /api/marketplace-customer-service-accounts/{uuid}/
Summary: Update a service account
Path parameters:
  - uuid
Request body: yes

### marketplace_customer_service_accounts_partial_update
PATCH /api/marketplace-customer-service-accounts/{uuid}/
Summary: Partially update a service account
Path parameters:
  - uuid
Request body: yes

### marketplace_customer_service_accounts_destroy
DELETE /api/marketplace-customer-service-accounts/{uuid}/
Summary: Close a customer service account
Description: Deactivates a customer service account and revokes its API key.
Path parameters:
  - uuid

### marketplace_customer_service_accounts_rotate_api_key
POST /api/marketplace-customer-service-accounts/{uuid}/rotate_api_key/
Summary: Rotate API key for a customer service account
Description: Generates a new API key for the service account, immediately invalidating the old one. The new key is returned in the response.
Path parameters:
  - uuid

============================================================
## marketplace-customer-usage  (module: waldur_api_client.api.marketplace_customer_usage)
============================================================

### marketplace_customer_usage_components_usage_by_project_retrieve
GET /api/marketplace-customer-usage/{uuid}/components-usage-by-project/
Summary: Get per-project usage breakdown for a single offering
Description: Returns the customer's usage of one offering broken down by project. Each project entry includes an in-period total `usage` and a monthly `buckets` array. Projects are sorted by usage descending.
Path parameters:
  - uuid
Query parameters (3):
  - component_type
  - offering_uuid (required)
  - period_offset

### marketplace_customer_usage_components_usage_timeseries_retrieve
GET /api/marketplace-customer-usage/{uuid}/components-usage-timeseries/
Summary: Get monthly usage buckets for a single offering
Description: Returns a per-month timeseries of `ComponentUsage` for one offering, restricted to that offering's current `limit_period`. Buckets are keyed by `billing_period` (always month-start). `period_offset` shifts the window backward by N periods.
Path parameters:
  - uuid
Query parameters (3):
  - component_type
  - offering_uuid (required)
  - period_offset

### marketplace_customer_usage_components_usage_retrieve
GET /api/marketplace-customer-usage/{uuid}/components-usage/
Summary: Get resource usage statistics broken down per offering
Description: Returns one row per (offering, component type, billing type) for all non-terminated resources within the scope. Each row's `usage` and `limit_usage` are aggregated using the offering's own `limit_period`.
Path parameters:
  - uuid

============================================================
## marketplace-demo-presets  (module: waldur_api_client.api.marketplace_demo_presets)
============================================================

### marketplace_demo_presets_info_retrieve
GET /api/marketplace-demo-presets/info/{name}/
Summary: Get demo preset details
Description: Returns detailed information about a specific demo preset. Staff access only.
Path parameters:
  - name — Name of the preset

### marketplace_demo_presets_info_count
HEAD /api/marketplace-demo-presets/info/{name}/
Summary: Get demo preset details
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - name — Name of the preset

### marketplace_demo_presets_list_list
GET /api/marketplace-demo-presets/list/
Summary: List demo presets
Description: Returns a list of available demo data presets. Staff access only.

### marketplace_demo_presets_list_count
HEAD /api/marketplace-demo-presets/list/
Summary: List demo presets
Description: Get number of items in the collection matching the request parameters.

### marketplace_demo_presets_load
POST /api/marketplace-demo-presets/load/{name}/
Summary: Load demo preset
Description: Load a demo preset into the database. This operation will optionally clean up existing data before loading. Staff access only.
Path parameters:
  - name — Name of the preset to load
Request body: yes

============================================================
## marketplace-global-categories  (module: waldur_api_client.api.marketplace_global_categories)
============================================================

### marketplace_global_categories_retrieve
GET /api/marketplace-global-categories/
Summary: Get resource counts by category
Description: Returns a dictionary mapping marketplace category UUIDs to the count of active (non-terminated)
        resources the current user has access to within that category. This is primarily used for UI
        dashboards or sidebars to display the number of resources in each category filter.

        ...
Query parameters (2):
  - customer_uuid — Filter counts by resources within a specific customer.
  - project_uuid — Filter counts by resources within a specific project.

============================================================
## marketplace-integration-statuses  (module: waldur_api_client.api.marketplace_integration_statuses)
============================================================

### marketplace_integration_statuses_list
GET /api/marketplace-integration-statuses/
Summary: List integration statuses
Description: Returns a paginated list of integration statuses for offerings. This is used to monitor the connectivity and health of backend agents (e.g., site agents) associated with offerings.
Query parameters (8):
  - agent_type — Agent type
  - customer_uuid — Customer UUID
  - o — Ordering
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Multiple values may be separated by commas.
  - parent_offering_uuid
  - status — Integration status

### marketplace_integration_statuses_count
HEAD /api/marketplace-integration-statuses/
Summary: List integration statuses
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - agent_type — Agent type
  - customer_uuid — Customer UUID
  - o — Ordering
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Multiple values may be separated by commas.
  - parent_offering_uuid
  - status — Integration status

### marketplace_integration_statuses_retrieve
GET /api/marketplace-integration-statuses/{uuid}/
Summary: Retrieve an integration status
Description: Returns the details of a specific integration status, including the agent type, status, and last request timestamp.
Path parameters:
  - uuid

============================================================
## marketplace-offering-estimated-cost-policies  (module: waldur_api_client.api.marketplace_offering_estimated_cost_policies)
============================================================

### marketplace_offering_estimated_cost_policies_list
GET /api/marketplace-offering-estimated-cost-policies/
Query parameters (2):
  - scope
  - scope_uuid

### marketplace_offering_estimated_cost_policies_count
HEAD /api/marketplace-offering-estimated-cost-policies/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - scope
  - scope_uuid

### marketplace_offering_estimated_cost_policies_create
POST /api/marketplace-offering-estimated-cost-policies/
Request body: yes

### marketplace_offering_estimated_cost_policies_actions_retrieve
GET /api/marketplace-offering-estimated-cost-policies/actions/
Summary: List available actions for OfferingEstimatedCostPolicy

### marketplace_offering_estimated_cost_policies_actions_count
HEAD /api/marketplace-offering-estimated-cost-policies/actions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_offering_estimated_cost_policies_retrieve
GET /api/marketplace-offering-estimated-cost-policies/{uuid}/
Path parameters:
  - uuid

### marketplace_offering_estimated_cost_policies_update
PUT /api/marketplace-offering-estimated-cost-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_estimated_cost_policies_partial_update
PATCH /api/marketplace-offering-estimated-cost-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_estimated_cost_policies_destroy
DELETE /api/marketplace-offering-estimated-cost-policies/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-offering-files  (module: waldur_api_client.api.marketplace_offering_files)
============================================================

### marketplace_offering_files_list
GET /api/marketplace-offering-files/
Query parameters (6):
  - field
  - o — Ordering
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Multiple values may be separated by commas.
  - parent_offering_uuid

### marketplace_offering_files_count
HEAD /api/marketplace-offering-files/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - o — Ordering
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Multiple values may be separated by commas.
  - parent_offering_uuid

### marketplace_offering_files_create
POST /api/marketplace-offering-files/
Request body: yes

### marketplace_offering_files_retrieve
GET /api/marketplace-offering-files/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_offering_files_destroy
DELETE /api/marketplace-offering-files/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-offering-groups  (module: waldur_api_client.api.marketplace_offering_groups)
============================================================

### marketplace_offering_groups_list
GET /api/marketplace-offering-groups/
Query parameters (3):
  - customer_uuid — Customer UUID
  - field
  - title

### marketplace_offering_groups_count
HEAD /api/marketplace-offering-groups/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - customer_uuid — Customer UUID
  - title

### marketplace_offering_groups_create
POST /api/marketplace-offering-groups/
Request body: yes

### marketplace_offering_groups_retrieve
GET /api/marketplace-offering-groups/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_offering_groups_update
PUT /api/marketplace-offering-groups/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_groups_partial_update
PATCH /api/marketplace-offering-groups/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_groups_destroy
DELETE /api/marketplace-offering-groups/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-offering-permissions  (module: waldur_api_client.api.marketplace_offering_permissions)
============================================================

### marketplace_offering_permissions_list
GET /api/marketplace-offering-permissions/
Query parameters (19):
  - created — Created after
  - created_before — Created before
  - customer
  - full_name — User full name contains
  - is_active
  - modified — Modified after
  - modified_before — Modified before
  - native_name
  - o — Ordering
  - offering
  - role_name — Role name contains
  - role_uuid — Role UUID
  - scope_name — Scope name
  - scope_type — Scope type
  - scope_uuid — Scope UUID
  - user
  - user_slug — User slug contains
  - user_url
  - username

### marketplace_offering_permissions_count
HEAD /api/marketplace-offering-permissions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (19):
  - created — Created after
  - created_before — Created before
  - customer
  - full_name — User full name contains
  - is_active
  - modified — Modified after
  - modified_before — Modified before
  - native_name
  - o — Ordering
  - offering
  - role_name — Role name contains
  - role_uuid — Role UUID
  - scope_name — Scope name
  - scope_type — Scope type
  - scope_uuid — Scope UUID
  - user
  - user_slug — User slug contains
  - user_url
  - username

### marketplace_offering_permissions_retrieve
GET /api/marketplace-offering-permissions/{id}/
Path parameters:
  - id — A unique integer value identifying this user role.

============================================================
## marketplace-offering-permissions-log  (module: waldur_api_client.api.marketplace_offering_permissions_log)
============================================================

### marketplace_offering_permissions_log_list
GET /api/marketplace-offering-permissions-log/
Query parameters (19):
  - created — Created after
  - created_before — Created before
  - customer
  - full_name — User full name contains
  - is_active
  - modified — Modified after
  - modified_before — Modified before
  - native_name
  - o — Ordering
  - offering
  - role_name — Role name contains
  - role_uuid — Role UUID
  - scope_name — Scope name
  - scope_type — Scope type
  - scope_uuid — Scope UUID
  - user
  - user_slug — User slug contains
  - user_url
  - username

### marketplace_offering_permissions_log_count
HEAD /api/marketplace-offering-permissions-log/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (19):
  - created — Created after
  - created_before — Created before
  - customer
  - full_name — User full name contains
  - is_active
  - modified — Modified after
  - modified_before — Modified before
  - native_name
  - o — Ordering
  - offering
  - role_name — Role name contains
  - role_uuid — Role UUID
  - scope_name — Scope name
  - scope_type — Scope type
  - scope_uuid — Scope UUID
  - user
  - user_slug — User slug contains
  - user_url
  - username

### marketplace_offering_permissions_log_retrieve
GET /api/marketplace-offering-permissions-log/{id}/
Path parameters:
  - id — A unique integer value identifying this user role.

============================================================
## marketplace-offering-profiles  (module: waldur_api_client.api.marketplace_offering_profiles)
============================================================

### marketplace_offering_profiles_list
GET /api/marketplace-offering-profiles/

### marketplace_offering_profiles_count
HEAD /api/marketplace-offering-profiles/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_offering_profiles_create
POST /api/marketplace-offering-profiles/
Request body: yes

### marketplace_offering_profiles_retrieve
GET /api/marketplace-offering-profiles/{uuid}/
Path parameters:
  - uuid

### marketplace_offering_profiles_update
PUT /api/marketplace-offering-profiles/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_profiles_partial_update
PATCH /api/marketplace-offering-profiles/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_profiles_destroy
DELETE /api/marketplace-offering-profiles/{uuid}/
Path parameters:
  - uuid

### marketplace_offering_profiles_add_role
POST /api/marketplace-offering-profiles/{uuid}/add_role/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_profiles_remove_role
POST /api/marketplace-offering-profiles/{uuid}/remove_role/
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-offering-referrals  (module: waldur_api_client.api.marketplace_offering_referrals)
============================================================

### marketplace_offering_referrals_list
GET /api/marketplace-offering-referrals/
Summary: List Datacite referrals for offerings
Description: Returns a paginated list of Datacite referrals associated with marketplace offerings. Referrals represent relationships between an offering (identified by a DOI) and other research outputs, such as publications or datasets. The list must be filtered by the offering's scope.
Query parameters (2):
  - o — Ordering
  - scope — Filter by scope URL.

### marketplace_offering_referrals_count
HEAD /api/marketplace-offering-referrals/
Summary: List Datacite referrals for offerings
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - o — Ordering
  - scope — Filter by scope URL.

### marketplace_offering_referrals_retrieve
GET /api/marketplace-offering-referrals/{uuid}/
Summary: Retrieve a specific Datacite referral
Description: Returns the details of a single Datacite referral record, identified by its UUID. Details include the related identifier (PID), the type of relationship, and metadata about the related work.
Path parameters:
  - uuid

============================================================
## marketplace-offering-roles  (module: waldur_api_client.api.marketplace_offering_roles)
============================================================

### marketplace_offering_roles_list
GET /api/marketplace-offering-roles/
Query parameters (3):
  - content_type
  - name
  - offering_uuid

### marketplace_offering_roles_count
HEAD /api/marketplace-offering-roles/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - content_type
  - name
  - offering_uuid

### marketplace_offering_roles_create
POST /api/marketplace-offering-roles/
Request body: yes

### marketplace_offering_roles_retrieve
GET /api/marketplace-offering-roles/{uuid}/
Path parameters:
  - uuid

### marketplace_offering_roles_update
PUT /api/marketplace-offering-roles/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_roles_partial_update
PATCH /api/marketplace-offering-roles/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_roles_destroy
DELETE /api/marketplace-offering-roles/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-offering-terms-of-service  (module: waldur_api_client.api.marketplace_offering_terms_of_service)
============================================================

### marketplace_offering_terms_of_service_list
GET /api/marketplace-offering-terms-of-service/
Summary: List Terms of Service configurations
Description: Returns a paginated list of Terms of Service configurations for offerings. Visibility depends on user permissions: staff/support see all; service providers see their own; regular users see ToS for offerings they have consented to or shared offerings.
Query parameters (6):
  - is_active — Is active
  - o — Ordering
  - offering — Offering URL
  - offering_uuid — Offering UUID
  - requires_reconsent — Requires reconsent
  - version — Version

### marketplace_offering_terms_of_service_count
HEAD /api/marketplace-offering-terms-of-service/
Summary: List Terms of Service configurations
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - is_active — Is active
  - o — Ordering
  - offering — Offering URL
  - offering_uuid — Offering UUID
  - requires_reconsent — Requires reconsent
  - version — Version

### marketplace_offering_terms_of_service_create
POST /api/marketplace-offering-terms-of-service/
Summary: Create a Terms of Service configuration
Description: Creates a new Terms of Service configuration for an offering. Only one active ToS configuration is allowed per offering.
Request body: yes

### marketplace_offering_terms_of_service_retrieve
GET /api/marketplace-offering-terms-of-service/{uuid}/
Summary: Retrieve a Terms of Service configuration
Description: Returns the details of a specific Terms of Service configuration.
Path parameters:
  - uuid

### marketplace_offering_terms_of_service_update
PUT /api/marketplace-offering-terms-of-service/{uuid}/
Summary: Update a Terms of Service configuration
Description: Updates an existing Terms of Service configuration. Note that some fields like `version` and `requires_reconsent` are protected and cannot be changed after creation.
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_terms_of_service_partial_update
PATCH /api/marketplace-offering-terms-of-service/{uuid}/
Summary: Partially update a Terms of Service configuration
Description: Partially updates an existing Terms of Service configuration.
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_terms_of_service_destroy
DELETE /api/marketplace-offering-terms-of-service/{uuid}/
Summary: Delete a Terms of Service configuration
Description: Deletes a Terms of Service configuration. This is a hard delete and should be used with caution.
Path parameters:
  - uuid

============================================================
## marketplace-offering-usage-policies  (module: waldur_api_client.api.marketplace_offering_usage_policies)
============================================================

### marketplace_offering_usage_policies_list
GET /api/marketplace-offering-usage-policies/
Query parameters (2):
  - scope
  - scope_uuid

### marketplace_offering_usage_policies_count
HEAD /api/marketplace-offering-usage-policies/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - scope
  - scope_uuid

### marketplace_offering_usage_policies_create
POST /api/marketplace-offering-usage-policies/
Request body: yes

### marketplace_offering_usage_policies_actions_retrieve
GET /api/marketplace-offering-usage-policies/actions/

### marketplace_offering_usage_policies_actions_count
HEAD /api/marketplace-offering-usage-policies/actions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_offering_usage_policies_retrieve
GET /api/marketplace-offering-usage-policies/{uuid}/
Path parameters:
  - uuid

### marketplace_offering_usage_policies_update
PUT /api/marketplace-offering-usage-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_usage_policies_partial_update
PATCH /api/marketplace-offering-usage-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_usage_policies_destroy
DELETE /api/marketplace-offering-usage-policies/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-offering-user-checklist-completions  (module: waldur_api_client.api.marketplace_offering_user_checklist_completions)
============================================================

### marketplace_offering_user_checklist_completions_list
GET /api/marketplace-offering-user-checklist-completions/
Summary: List checklist completions for offering users
Description: Returns a paginated list of all checklist completions for offering users that the current user is allowed to see.
        This endpoint is used by service providers to monitor compliance status and by users to see their own required checklists.
        Visibility follows the same rules as the `Of...
Query parameters (8):
  - created — Created after
  - created_before — Created before
  - is_completed
  - modified — Modified after
  - modified_before — Modified before
  - o — Ordering
  - offering_uuid — Filter by offering UUID
  - user_uuid — Filter by user UUID

### marketplace_offering_user_checklist_completions_count
HEAD /api/marketplace-offering-user-checklist-completions/
Summary: List checklist completions for offering users
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - created — Created after
  - created_before — Created before
  - is_completed
  - modified — Modified after
  - modified_before — Modified before
  - o — Ordering
  - offering_uuid — Filter by offering UUID
  - user_uuid — Filter by user UUID

### marketplace_offering_user_checklist_completions_retrieve
GET /api/marketplace-offering-user-checklist-completions/{id}/
Summary: Retrieve a checklist completion
Description: Returns the details of a specific checklist completion for an offering user.
Path parameters:
  - id — A unique integer value identifying this Checklist completion.

============================================================
## marketplace-offering-users  (module: waldur_api_client.api.marketplace_offering_users)
============================================================

### marketplace_offering_users_list
GET /api/marketplace-offering-users/
Summary: List offering users
Description: Returns a paginated list of users associated with offerings. The visibility of users depends on the role of the authenticated user. Staff and support can see all users. Service providers can see users of their offerings if the user has consented. Regular users can only see their own offering-user...
Query parameters (20):
  - created — Created after
  - created_before — Created before
  - field
  - has_complete_profile — User has complete profile for the offering
  - has_consent — User Has Consent
  - is_restricted — Is restricted
  - modified — Modified after
  - modified_before — Modified before
  - o — Ordering
  - offering
  - offering_has_active_tos — Offering has active Terms of Service
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Multiple values may be separated by commas.
  - parent_offering_uuid
  - provider_uuid — Provider UUID
  - query — Search by offering name, username, user name, UID or primary GID
  - runtime_state — Offering user runtime state
  - state — Offering user state
  - user_username — User username
  - user_uuid — User UUID

### marketplace_offering_users_count
HEAD /api/marketplace-offering-users/
Summary: List offering users
Description: Get number of items in the collection matching the request parameters.
Query parameters (19):
  - created — Created after
  - created_before — Created before
  - has_complete_profile — User has complete profile for the offering
  - has_consent — User Has Consent
  - is_restricted — Is restricted
  - modified — Modified after
  - modified_before — Modified before
  - o — Ordering
  - offering
  - offering_has_active_tos — Offering has active Terms of Service
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Multiple values may be separated by commas.
  - parent_offering_uuid
  - provider_uuid — Provider UUID
  - query — Search by offering name, username, user name, UID or primary GID
  - runtime_state — Offering user runtime state
  - state — Offering user state
  - user_username — User username
  - user_uuid — User UUID

### marketplace_offering_users_create
POST /api/marketplace-offering-users/
Summary: Create an offering user
Description: Associates a user with a specific offering, creating an offering-specific user account. This is typically done by a service provider.
Request body: yes

### marketplace_offering_users_checklist_template_retrieve
GET /api/marketplace-offering-users/checklist-template/
Summary: Get checklist template for creating new objects
Description: Get checklist template for creating new objects.
Query parameters (1):
  - parent_uuid (required) — UUID of the parent object (e.g., customer UUID for new projects)

### marketplace_offering_users_checklist_template_count
HEAD /api/marketplace-offering-users/checklist-template/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - parent_uuid (required) — UUID of the parent object (e.g., customer UUID for new projects)

### marketplace_offering_users_posix_identities_list
GET /api/marketplace-offering-users/posix_identities/
Summary: List a user's POSIX identities across all their offerings
Description: Consolidated view of one user's POSIX identifiers (UID, primary GID and project group GIDs) across every offering they have an account on, each with the range it was allocated from. Scoped to the offering users the requester is allowed to see.
Query parameters (19):
  - created — Created after
  - created_before — Created before
  - has_complete_profile — User has complete profile for the offering
  - has_consent — User Has Consent
  - is_restricted — Is restricted
  - modified — Modified after
  - modified_before — Modified before
  - o — Ordering
  - offering
  - offering_has_active_tos — Offering has active Terms of Service
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Multiple values may be separated by commas.
  - parent_offering_uuid
  - provider_uuid — Provider UUID
  - query — Search by offering name, username, user name, UID or primary GID
  - runtime_state — Offering user runtime state
  - state — Offering user state
  - user_username — User username
  - user_uuid (required)

### marketplace_offering_users_posix_identities_count
HEAD /api/marketplace-offering-users/posix_identities/
Summary: List a user's POSIX identities across all their offerings
Description: Get number of items in the collection matching the request parameters.
Query parameters (19):
  - created — Created after
  - created_before — Created before
  - has_complete_profile — User has complete profile for the offering
  - has_consent — User Has Consent
  - is_restricted — Is restricted
  - modified — Modified after
  - modified_before — Modified before
  - o — Ordering
  - offering
  - offering_has_active_tos — Offering has active Terms of Service
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Multiple values may be separated by commas.
  - parent_offering_uuid
  - provider_uuid — Provider UUID
  - query — Search by offering name, username, user name, UID or primary GID
  - runtime_state — Offering user runtime state
  - state — Offering user state
  - user_username — User username
  - user_uuid (required)

### marketplace_offering_users_profile_field_warnings_retrieve
GET /api/marketplace-offering-users/profile_field_warnings/
Summary: Get profile field warnings
Description: Returns a mapping of user profile field names to offerings that expose those fields. When ENFORCE_OFFERING_USER_PROFILE_COMPLETENESS is enabled, clearing a field listed here would make the user invisible to the service provider for the associated offerings.

### marketplace_offering_users_profile_field_warnings_count
HEAD /api/marketplace-offering-users/profile_field_warnings/
Summary: Get profile field warnings
Description: Get number of items in the collection matching the request parameters.

### marketplace_offering_users_retrieve
GET /api/marketplace-offering-users/{uuid}/
Summary: Retrieve an offering user
Description: Returns the details of a specific offering-user link. Visibility follows the same rules as the list view.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_offering_users_update
PUT /api/marketplace-offering-users/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_users_partial_update
PATCH /api/marketplace-offering-users/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_users_destroy
DELETE /api/marketplace-offering-users/{uuid}/
Summary: Delete an offering user
Description: Removes the association between a user and an offering. This action may trigger backend cleanup processes depending on the offering type.
Path parameters:
  - uuid

### marketplace_offering_users_begin_creating
POST /api/marketplace-offering-users/{uuid}/begin_creating/
Summary: Begin creation process
Description: Transitions the offering user state from 'Requested' or 'Error Creating' to 'Creating'. This is typically used by an agent to signal that the creation process has started.
Path parameters:
  - uuid

### marketplace_offering_users_checklist_retrieve
GET /api/marketplace-offering-users/{uuid}/checklist/
Summary: Get checklist with questions and existing answers
Description: Get checklist with questions and existing answers.
Path parameters:
  - uuid
Query parameters (1):
  - include_all — If true, returns all questions including hidden ones (for dynamic form visibility). Default: false.

### marketplace_offering_users_checklist_review_retrieve
GET /api/marketplace-offering-users/{uuid}/checklist_review/
Summary: Get checklist with questions and existing answers including review logic (reviewers only)
Description: Get checklist with questions and existing answers including review logic (reviewers only).
Path parameters:
  - uuid

### marketplace_offering_users_completion_review_status_retrieve
GET /api/marketplace-offering-users/{uuid}/completion_review_status/
Summary: Get checklist completion status with review triggers (reviewers only)
Description: Get checklist completion status with review triggers (reviewers only).
Path parameters:
  - uuid

### marketplace_offering_users_completion_status_retrieve
GET /api/marketplace-offering-users/{uuid}/completion_status/
Summary: Get checklist completion status
Description: Get checklist completion status.
Path parameters:
  - uuid

### marketplace_offering_users_posix_allocations_list
GET /api/marketplace-offering-users/{uuid}/posix_allocations/
Summary: List POSIX UID/GID allocations of an offering user
Description: Returns the user's POSIX identifiers (UID, primary GID) and, for each, the POSIX ID pool that tracks it. The pool fields are null when the value is not tracked by a pool.
Path parameters:
  - uuid
Query parameters (19):
  - created — Created after
  - created_before — Created before
  - has_complete_profile — User has complete profile for the offering
  - has_consent — User Has Consent
  - is_restricted — Is restricted
  - modified — Modified after
  - modified_before — Modified before
  - o — Ordering
  - offering
  - offering_has_active_tos — Offering has active Terms of Service
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Multiple values may be separated by commas.
  - parent_offering_uuid
  - provider_uuid — Provider UUID
  - query — Search by offering name, username, user name, UID or primary GID
  - runtime_state — Offering user runtime state
  - state — Offering user state
  - user_username — User username
  - user_uuid — User UUID

### marketplace_offering_users_posix_groups_list
GET /api/marketplace-offering-users/{uuid}/posix_groups/
Summary: List project group GIDs an offering user belongs to
Description: Returns the project group GIDs (shared GIDs that appear in the user's GLAuth otherGroups) for this offering user.
Path parameters:
  - uuid
Query parameters (19):
  - created — Created after
  - created_before — Created before
  - has_complete_profile — User has complete profile for the offering
  - has_consent — User Has Consent
  - is_restricted — Is restricted
  - modified — Modified after
  - modified_before — Modified before
  - o — Ordering
  - offering
  - offering_has_active_tos — Offering has active Terms of Service
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Multiple values may be separated by commas.
  - parent_offering_uuid
  - provider_uuid — Provider UUID
  - query — Search by offering name, username, user name, UID or primary GID
  - runtime_state — Offering user runtime state
  - state — Offering user state
  - user_username — User username
  - user_uuid — User UUID

### marketplace_offering_users_request_deletion
POST /api/marketplace-offering-users/{uuid}/request_deletion/
Summary: Request deletion of an offering user
Description: Initiates the deletion process for an offering user account by transitioning it to the 'Deletion Requested' state.
Path parameters:
  - uuid

### marketplace_offering_users_set_deleted
POST /api/marketplace-offering-users/{uuid}/set_deleted/
Summary: Set state to Deleted
Description: Transitions the offering user to the 'Deleted' state, marking the successful completion of the deletion process.
Path parameters:
  - uuid

### marketplace_offering_users_set_deleting
POST /api/marketplace-offering-users/{uuid}/set_deleting/
Summary: Begin deletion process
Description: Transitions the offering user to the 'Deleting' state. This is typically used by an agent to signal that the deletion process has started.
Path parameters:
  - uuid

### marketplace_offering_users_set_error_creating
POST /api/marketplace-offering-users/{uuid}/set_error_creating/
Summary: Set state to Error Creating
Description: Manually moves the offering user into the 'Error Creating' state. This is typically used by an agent to report a failure during the creation process.
Path parameters:
  - uuid

### marketplace_offering_users_set_error_deleting
POST /api/marketplace-offering-users/{uuid}/set_error_deleting/
Summary: Set state to Error Deleting
Description: Manually moves the offering user into the 'Error Deleting' state. This is typically used by an agent to report a failure during the deletion process.
Path parameters:
  - uuid

### marketplace_offering_users_set_ok
POST /api/marketplace-offering-users/{uuid}/set_ok/
Summary: Set state to OK
Description: Manually sets the offering user state to 'OK'. This can be used to recover from an error state or to complete a manual creation process.
Path parameters:
  - uuid

### marketplace_offering_users_set_pending_account_linking
POST /api/marketplace-offering-users/{uuid}/set_pending_account_linking/
Summary: Set state to Pending Account Linking
Description: Transitions the state to 'Pending Account Linking' and allows a service provider to add a comment and a URL to guide the user.
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_users_set_pending_additional_validation
POST /api/marketplace-offering-users/{uuid}/set_pending_additional_validation/
Summary: Set state to Pending Additional Validation
Description: Transitions the state to 'Pending Additional Validation' and allows a service provider to add a comment and a URL for the user to follow.
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_users_set_posix_attributes
POST /api/marketplace-offering-users/{uuid}/set_posix_attributes/
Summary: Set POSIX attributes for an offering user
Description: Override the login shell, home directory, UID and/or primary GID for a single offering user, taking precedence over the offering-level defaults / the range allocator. UID and primary GID re-point the allocation ledger; values outside every active range are accepted but reported in the response 'w...
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_users_set_validation_complete
POST /api/marketplace-offering-users/{uuid}/set_validation_complete/
Summary: Set state to Validation Complete
Description: Transitions the state from a pending validation state to 'OK', indicating that the user has completed the required steps. This clears any service provider comments.
Path parameters:
  - uuid

### marketplace_offering_users_submit_answers
POST /api/marketplace-offering-users/{uuid}/submit_answers/
Summary: Submit checklist answers
Description: Submit checklist answers.
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_users_update_comments_partial_update
PATCH /api/marketplace-offering-users/{uuid}/update_comments/
Summary: Update service provider comments
Description: Allows a service provider to update the `service_provider_comment` and `service_provider_comment_url` fields for an offering user. This is often used to provide feedback or instructions during a pending state.
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_users_update_restricted
POST /api/marketplace-offering-users/{uuid}/update_restricted/
Summary: Update restriction status
Description: Allows a service provider to mark an offering user as restricted or unrestricted. A restricted user may have limited access to the resource.
Path parameters:
  - uuid
Request body: yes

### marketplace_offering_users_update_runtime_state
POST /api/marketplace-offering-users/{uuid}/update_runtime_state/
Summary: Update runtime state
Description: Allows a service provider to set the operational/access state of an offering user. Unlike the lifecycle state, this can be updated at any time (except when the account is Deleted). Use this to signal access blockers such as pending Terms of Use acceptance or pending account linking (e.g. MyAccess...
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-openstack-duplicate-offerings  (module: waldur_api_client.api.marketplace_openstack_duplicate_offerings)
============================================================

### marketplace_openstack_duplicate_offerings_list
GET /api/marketplace-openstack-duplicate-offerings/

### marketplace_openstack_duplicate_offerings_count
HEAD /api/marketplace-openstack-duplicate-offerings/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

============================================================
## marketplace-orders  (module: waldur_api_client.api.marketplace_orders)
============================================================

### marketplace_orders_list
GET /api/marketplace-orders/
Summary: List orders
Description: Returns a paginated list of orders accessible to the current user. Orders are visible to service consumers (project/customer members with appropriate permissions) and service providers.
Query parameters (26):
  - can_approve_as_consumer — Can approve as consumer
  - can_approve_as_provider — Can approve as provider
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer_uuid — Customer UUID
  - field
  - modified — Modified after
  - modified_before — Modified before
  - o — Ordering
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_type — Offering type
  - offering_uuid — Offering UUID
  - parent_offering_uuid
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - query — Search by order UUID, slug, project name or resource name
  - resource — Resource URL
  - resource_name — Resource name
  - resource_uuid — Resource UUID
  - service_manager_uuid — Service manager UUID
  - slug — Slug
  - state — Order state
  - type — Order type
  - was_auto_approved — Auto-approved

### marketplace_orders_count
HEAD /api/marketplace-orders/
Summary: List orders
Description: Get number of items in the collection matching the request parameters.
Query parameters (25):
  - can_approve_as_consumer — Can approve as consumer
  - can_approve_as_provider — Can approve as provider
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer_uuid — Customer UUID
  - modified — Modified after
  - modified_before — Modified before
  - o — Ordering
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_type — Offering type
  - offering_uuid — Offering UUID
  - parent_offering_uuid
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - query — Search by order UUID, slug, project name or resource name
  - resource — Resource URL
  - resource_name — Resource name
  - resource_uuid — Resource UUID
  - service_manager_uuid — Service manager UUID
  - slug — Slug
  - state — Order state
  - type — Order type
  - was_auto_approved — Auto-approved

### marketplace_orders_create
POST /api/marketplace-orders/
Summary: Create an order
Description: Creates a new order to provision a resource. The order will be placed in a pending state and may require approval depending on the offering and user permissions.
Request body: yes

### marketplace_orders_retrieve
GET /api/marketplace-orders/{uuid}/
Summary: Retrieve an order
Description: Returns the details of a specific order.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_orders_update
PUT /api/marketplace-orders/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_orders_partial_update
PATCH /api/marketplace-orders/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_orders_destroy
DELETE /api/marketplace-orders/{uuid}/
Summary: Delete a pending order
Description: Deletes an order that is still in a pending state (e.g., `pending-consumer` or `pending-provider`). Executing or completed orders cannot be deleted.
Path parameters:
  - uuid

### marketplace_orders_approve_by_consumer
POST /api/marketplace-orders/{uuid}/approve_by_consumer/
Summary: Approve an order (consumer)
Description: Approves a pending order from the consumer's side (e.g., project manager, customer owner). This transitions the order to the next state, which could be pending provider approval or executing.
Path parameters:
  - uuid

### marketplace_orders_approve_by_provider
POST /api/marketplace-orders/{uuid}/approve_by_provider/
Summary: Approve an order (provider)
Description: Approves a pending order from the provider's side. This typically transitions the order to the executing state.
Path parameters:
  - uuid
Request body: yes

### marketplace_orders_cancel
POST /api/marketplace-orders/{uuid}/cancel/
Summary: Cancel an order
Description: Cancels an order. This is typically only possible for certain offering types (e.g., basic support) and in specific states (pending or executing).
Path parameters:
  - uuid

### marketplace_orders_delete_attachment
POST /api/marketplace-orders/{uuid}/delete_attachment/
Summary: Delete order attachment
Description: Allows deleting an attachment from a pending order.
Path parameters:
  - uuid

### marketplace_orders_offering_retrieve
GET /api/marketplace-orders/{uuid}/offering/
Summary: Get offering details
Description: Returns details of the offering connected to the requested object.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_orders_reject_by_consumer
POST /api/marketplace-orders/{uuid}/reject_by_consumer/
Summary: Reject an order (consumer)
Description: Rejects a pending order from the consumer's side. This moves the order to the 'rejected' state.
Path parameters:
  - uuid
Request body: yes

### marketplace_orders_reject_by_provider
POST /api/marketplace-orders/{uuid}/reject_by_provider/
Summary: Reject an order (provider)
Description: Rejects a pending order from the provider's side. This moves the order to the 'rejected' state.
Path parameters:
  - uuid
Request body: yes

### marketplace_orders_resource_retrieve
GET /api/marketplace-orders/{uuid}/resource/
Summary: Get resource details
Description: Returns details of the resource connected to the requested object.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_orders_retry
POST /api/marketplace-orders/{uuid}/retry/
Summary: Retry an erred order
Description: Resets an erred order and its resource back to an active state so that the order can be reprocessed.
Path parameters:
  - uuid

### marketplace_orders_set_backend_id
POST /api/marketplace-orders/{uuid}/set_backend_id/
Summary: Set order backend ID
Description: Allows a service provider or staff to set or update the backend ID associated with an order. This is useful for linking the order to an external system's identifier.
Path parameters:
  - uuid
Request body: yes

### marketplace_orders_set_consumer_info
POST /api/marketplace-orders/{uuid}/set_consumer_info/
Summary: Set consumer info on order
Description: Allows a consumer to respond to a provider's message with an optional message and file attachment on a pending order.
Path parameters:
  - uuid
Request body: yes

### marketplace_orders_set_provider_info
POST /api/marketplace-orders/{uuid}/set_provider_info/
Summary: Set provider info on order
Description: Allows a service provider to send a message with an optional URL and file attachment to the consumer on a pending order.
Path parameters:
  - uuid
Request body: yes

### marketplace_orders_set_state_done
POST /api/marketplace-orders/{uuid}/set_state_done/
Summary: Set order state to done (agent)
Description: Used by external agents (e.g., site agent) to manually transition the order state to 'done'. This is only applicable for specific offering types.
Path parameters:
  - uuid

### marketplace_orders_set_state_erred
POST /api/marketplace-orders/{uuid}/set_state_erred/
Summary: Set order state to erred (agent)
Description: Used by external agents to report a failure during order processing. An error message and traceback can be provided.
Path parameters:
  - uuid
Request body: yes

### marketplace_orders_set_state_executing
POST /api/marketplace-orders/{uuid}/set_state_executing/
Summary: Set order state to executing (agent)
Description: Used by external agents (e.g., site agent) to manually transition the order state to 'executing'. This is only applicable for specific offering types.
Path parameters:
  - uuid

### marketplace_orders_unlink
POST /api/marketplace-orders/{uuid}/unlink/
Summary: Unlink an order (staff only)
Description: Forcefully deletes an order from the database without affecting the backend resource. This is a staff-only administrative action used to clean up stuck or invalid orders.
Path parameters:
  - uuid

### marketplace_orders_update_attachment
POST /api/marketplace-orders/{uuid}/update_attachment/
Summary: Update order attachment
Description: Allows uploading or replacing a file attachment (e.g., a purchase order) for a pending order.
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-plan-components  (module: waldur_api_client.api.marketplace_plan_components)
============================================================

### marketplace_plan_components_list
GET /api/marketplace-plan-components/
Summary: List plan components
Description: Returns a paginated list of all plan components. A plan component defines the pricing and quotas for an offering component within a billing plan. The list is filtered based on the current user's access permissions and organization group memberships.
Query parameters (4):
  - archived — Archived
  - offering_uuid — Offering UUID
  - plan_uuid — Plan UUID
  - shared — Shared

### marketplace_plan_components_count
HEAD /api/marketplace-plan-components/
Summary: List plan components
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - archived — Archived
  - offering_uuid — Offering UUID
  - plan_uuid — Plan UUID
  - shared — Shared

### marketplace_plan_components_retrieve
GET /api/marketplace-plan-components/{id}/
Summary: Retrieve a plan component
Description: Returns the details of a specific plan component, including its pricing, quotas, and associated offering and plan information.
Path parameters:
  - id — A unique integer value identifying this plan component.

============================================================
## marketplace-plans  (module: waldur_api_client.api.marketplace_plans)
============================================================

### marketplace_plans_list
GET /api/marketplace-plans/
Summary: List provider plans
Description: Returns a paginated list of plans managed by the provider. The list is filtered based on the current user's access to the offering's customer.
Query parameters (4):
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Offering UUID
  - parent_offering_uuid

### marketplace_plans_count
HEAD /api/marketplace-plans/
Summary: List provider plans
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Offering UUID
  - parent_offering_uuid

### marketplace_plans_create
POST /api/marketplace-plans/
Summary: Create a provider plan
Description: Creates a new billing plan for an offering.
Request body: yes

### marketplace_plans_usage_stats_list
GET /api/marketplace-plans/usage_stats/
Summary: Get plan usage statistics
Description: Returns aggregated statistics on how many resources are currently using each plan. Can be filtered by offering or service provider.
Query parameters (6):
  - customer_provider_uuid — Filter by offering customer provider UUID.
  - o — Ordering field. Available options: `usage`, `limit`, `remaining`, and their descending counterparts (e.g., `-usage`).
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Filter by offering UUID.
  - parent_offering_uuid

### marketplace_plans_usage_stats_count
HEAD /api/marketplace-plans/usage_stats/
Summary: Get plan usage statistics
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - customer_provider_uuid — Filter by offering customer provider UUID.
  - o — Ordering field. Available options: `usage`, `limit`, `remaining`, and their descending counterparts (e.g., `-usage`).
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Filter by offering UUID.
  - parent_offering_uuid

### marketplace_plans_retrieve
GET /api/marketplace-plans/{uuid}/
Summary: Retrieve a provider plan
Description: Returns details of a specific plan.
Path parameters:
  - uuid

### marketplace_plans_update
PUT /api/marketplace-plans/{uuid}/
Summary: Update a provider plan
Description: Updates an existing plan. Note: A plan cannot be updated if it is already used by resources.
Path parameters:
  - uuid
Request body: yes

### marketplace_plans_partial_update
PATCH /api/marketplace-plans/{uuid}/
Summary: Partially update a provider plan
Description: Partially updates an existing plan. Note: A plan cannot be updated if it is already used by resources.
Path parameters:
  - uuid
Request body: yes

### marketplace_plans_destroy
DELETE /api/marketplace-plans/{uuid}/
Summary: Delete a provider plan
Description: Deletes a plan. This is a hard delete and should be used with caution.
Path parameters:
  - uuid

### marketplace_plans_archive
POST /api/marketplace-plans/{uuid}/archive/
Summary: Archive a plan
Description: Marks a plan as archived. Archived plans cannot be used for provisioning new resources, but existing resources will continue to be billed according to this plan.
Path parameters:
  - uuid

### marketplace_plans_delete_organization_groups
POST /api/marketplace-plans/{uuid}/delete_organization_groups/
Summary: Remove all organization groups from a plan
Description: Removes all organization group associations from this plan, making it accessible to all users (subject to offering-level restrictions).
Path parameters:
  - uuid

### marketplace_plans_history_list
GET /api/marketplace-plans/{uuid}/history/
Summary: Get version history
Description: Returns the version history for this object. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (6):
  - created_after — Filter versions created after this timestamp (ISO 8601)
  - created_before — Filter versions created before this timestamp (ISO 8601)
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Offering UUID
  - parent_offering_uuid

### marketplace_plans_history_at_retrieve
GET /api/marketplace-plans/{uuid}/history/at/
Summary: Get object state at a specific timestamp
Description: Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (1):
  - timestamp (required) — ISO 8601 timestamp to query the object state at

### marketplace_plans_update_discounts
POST /api/marketplace-plans/{uuid}/update_discounts/
Summary: Update plan component discounts
Description: Update volume discount configuration for plan components.

        This endpoint allows updating discount thresholds and rates for multiple
        plan components in a single request. Discounts are applied automatically
        when limit quantities meet or exceed the threshold.

        The dis...
Path parameters:
  - uuid
Request body: yes

### marketplace_plans_update_organization_groups
POST /api/marketplace-plans/{uuid}/update_organization_groups/
Summary: Update organization groups for a plan
Description: Sets the list of organization groups that are allowed to access this plan. If the list is empty, the plan is accessible to all.
Path parameters:
  - uuid
Request body: yes

### marketplace_plans_update_prices
POST /api/marketplace-plans/{uuid}/update_prices/
Summary: Update plan component prices
Description: Updates the prices for one or more components of a specific plan. If the plan is already in use by resources, this action updates the `future_price`, which will be applied from the next billing period. Otherwise, the current `price` is updated directly.
Path parameters:
  - uuid
Request body: yes

### marketplace_plans_update_quotas
POST /api/marketplace-plans/{uuid}/update_quotas/
Summary: Update plan component quotas
Description: Updates the quotas (fixed amounts) for one or more components of a specific plan. This is only applicable for components with a 'fixed-price' billing type.
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-plugins  (module: waldur_api_client.api.marketplace_plugins)
============================================================

### marketplace_plugins_list
GET /api/marketplace-plugins/
Summary: List available marketplace plugins and their components
Description: 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.
        - `compon...

============================================================
## marketplace-posix-id-pools  (module: waldur_api_client.api.marketplace_posix_id_pools)
============================================================

### marketplace_posix_id_pools_list
GET /api/marketplace-posix-id-pools/
Query parameters (4):
  - customer_uuid — Customer UUID
  - field
  - offering_uuid — Offering UUID
  - service_provider_uuid — Service provider UUID

### marketplace_posix_id_pools_count
HEAD /api/marketplace-posix-id-pools/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - customer_uuid — Customer UUID
  - offering_uuid — Offering UUID
  - service_provider_uuid — Service provider UUID

### marketplace_posix_id_pools_create
POST /api/marketplace-posix-id-pools/
Request body: yes

### marketplace_posix_id_pools_retrieve
GET /api/marketplace-posix-id-pools/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_posix_id_pools_update
PUT /api/marketplace-posix-id-pools/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_posix_id_pools_partial_update
PATCH /api/marketplace-posix-id-pools/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_posix_id_pools_destroy
DELETE /api/marketplace-posix-id-pools/{uuid}/
Path parameters:
  - uuid

### marketplace_posix_id_pools_stats_retrieve
GET /api/marketplace-posix-id-pools/{uuid}/stats/
Summary: Pool utilization statistics
Path parameters:
  - uuid

============================================================
## marketplace-posix-identities  (module: waldur_api_client.api.marketplace_posix_identities)
============================================================

### marketplace_posix_identities_list
GET /api/marketplace-posix-identities/
Query parameters (3):
  - is_released
  - offering_uuid — Offering UUID
  - pool_uuid — POSIX ID pool UUID

### marketplace_posix_identities_count
HEAD /api/marketplace-posix-identities/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - is_released
  - offering_uuid — Offering UUID
  - pool_uuid — POSIX ID pool UUID

### marketplace_posix_identities_retrieve
GET /api/marketplace-posix-identities/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-project-estimated-cost-policies  (module: waldur_api_client.api.marketplace_project_estimated_cost_policies)
============================================================

### marketplace_project_estimated_cost_policies_list
GET /api/marketplace-project-estimated-cost-policies/
Query parameters (7):
  - customer
  - customer_uuid
  - project
  - project_uuid
  - query
  - scope
  - scope_uuid

### marketplace_project_estimated_cost_policies_count
HEAD /api/marketplace-project-estimated-cost-policies/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (7):
  - customer
  - customer_uuid
  - project
  - project_uuid
  - query
  - scope
  - scope_uuid

### marketplace_project_estimated_cost_policies_create
POST /api/marketplace-project-estimated-cost-policies/
Request body: yes

### marketplace_project_estimated_cost_policies_actions_retrieve
GET /api/marketplace-project-estimated-cost-policies/actions/

### marketplace_project_estimated_cost_policies_actions_count
HEAD /api/marketplace-project-estimated-cost-policies/actions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_project_estimated_cost_policies_retrieve
GET /api/marketplace-project-estimated-cost-policies/{uuid}/
Path parameters:
  - uuid

### marketplace_project_estimated_cost_policies_update
PUT /api/marketplace-project-estimated-cost-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_project_estimated_cost_policies_partial_update
PATCH /api/marketplace-project-estimated-cost-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_project_estimated_cost_policies_destroy
DELETE /api/marketplace-project-estimated-cost-policies/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-project-order-auto-approvals  (module: waldur_api_client.api.marketplace_project_order_auto_approvals)
============================================================

### marketplace_project_order_auto_approvals_list
GET /api/marketplace-project-order-auto-approvals/
Query parameters (3):
  - customer_uuid — Customer UUID
  - enabled
  - project_uuid — Project UUID

### marketplace_project_order_auto_approvals_count
HEAD /api/marketplace-project-order-auto-approvals/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - customer_uuid — Customer UUID
  - enabled
  - project_uuid — Project UUID

### marketplace_project_order_auto_approvals_create
POST /api/marketplace-project-order-auto-approvals/
Request body: yes

### marketplace_project_order_auto_approvals_retrieve
GET /api/marketplace-project-order-auto-approvals/{uuid}/
Path parameters:
  - uuid

### marketplace_project_order_auto_approvals_update
PUT /api/marketplace-project-order-auto-approvals/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_project_order_auto_approvals_partial_update
PATCH /api/marketplace-project-order-auto-approvals/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_project_order_auto_approvals_destroy
DELETE /api/marketplace-project-order-auto-approvals/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-project-posix-groups  (module: waldur_api_client.api.marketplace_project_posix_groups)
============================================================

### marketplace_project_posix_groups_list
GET /api/marketplace-project-posix-groups/
Summary: List POSIX group GIDs assigned to a project
Description: Returns every POSIX group GID a project has been assigned, across all offerings: project-mapped groups (project_group_gid) and resource / resource-project role groups (role_group_gid). The project_uuid query parameter is required.
Query parameters (1):
  - project_uuid (required)

### marketplace_project_posix_groups_count
HEAD /api/marketplace-project-posix-groups/
Summary: List POSIX group GIDs assigned to a project
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - project_uuid (required)

============================================================
## marketplace-project-service-accounts  (module: waldur_api_client.api.marketplace_project_service_accounts)
============================================================

### marketplace_project_service_accounts_list
GET /api/marketplace-project-service-accounts/
Summary: List service accounts
Query parameters (5):
  - email — Email contains
  - project — Project URL
  - project_uuid — Project UUID
  - state — Service account state
  - username — Username

### marketplace_project_service_accounts_count
HEAD /api/marketplace-project-service-accounts/
Summary: List service accounts
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - email — Email contains
  - project — Project URL
  - project_uuid — Project UUID
  - state — Service account state
  - username — Username

### marketplace_project_service_accounts_create
POST /api/marketplace-project-service-accounts/
Summary: Create a project service account
Description: Creates a new service account scoped to a specific project. This generates an API key that can be used for automated access to resources within that project.
Request body: yes

### marketplace_project_service_accounts_retrieve
GET /api/marketplace-project-service-accounts/{uuid}/
Summary: Retrieve a service account
Path parameters:
  - uuid

### marketplace_project_service_accounts_update
PUT /api/marketplace-project-service-accounts/{uuid}/
Summary: Update a service account
Path parameters:
  - uuid
Request body: yes

### marketplace_project_service_accounts_partial_update
PATCH /api/marketplace-project-service-accounts/{uuid}/
Summary: Partially update a service account
Path parameters:
  - uuid
Request body: yes

### marketplace_project_service_accounts_destroy
DELETE /api/marketplace-project-service-accounts/{uuid}/
Summary: Close a project service account
Description: Deactivates a project service account and revokes its API key.
Path parameters:
  - uuid

### marketplace_project_service_accounts_rotate_api_key
POST /api/marketplace-project-service-accounts/{uuid}/rotate_api_key/
Summary: Rotate API key for a project service account
Description: Generates a new API key for the service account, immediately invalidating the old one. The new key is returned in the response.
Path parameters:
  - uuid

============================================================
## marketplace-project-update-requests  (module: waldur_api_client.api.marketplace_project_update_requests)
============================================================

### marketplace_project_update_requests_list
GET /api/marketplace-project-update-requests/
Query parameters (5):
  - customer_uuid
  - offering_uuid
  - project_uuid
  - provider_uuid
  - state

### marketplace_project_update_requests_count
HEAD /api/marketplace-project-update-requests/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - customer_uuid
  - offering_uuid
  - project_uuid
  - provider_uuid
  - state

### marketplace_project_update_requests_retrieve
GET /api/marketplace-project-update-requests/{uuid}/
Path parameters:
  - uuid

### marketplace_project_update_requests_approve
POST /api/marketplace-project-update-requests/{uuid}/approve/
Summary: Approve project update request
Path parameters:
  - uuid
Request body: yes

### marketplace_project_update_requests_reject
POST /api/marketplace-project-update-requests/{uuid}/reject/
Summary: Reject project update request
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-project-usage  (module: waldur_api_client.api.marketplace_project_usage)
============================================================

### marketplace_project_usage_components_usage_timeseries_retrieve
GET /api/marketplace-project-usage/{uuid}/components-usage-timeseries/
Summary: Get monthly usage buckets for a single offering
Description: Returns a per-month timeseries of `ComponentUsage` for one offering, restricted to that offering's current `limit_period`. Buckets are keyed by `billing_period` (always month-start). `period_offset` shifts the window backward by N periods.
Path parameters:
  - uuid
Query parameters (3):
  - component_type
  - offering_uuid (required)
  - period_offset

### marketplace_project_usage_components_usage_retrieve
GET /api/marketplace-project-usage/{uuid}/components-usage/
Summary: Get resource usage statistics broken down per offering
Description: Returns one row per (offering, component type, billing type) for all non-terminated resources within the scope. Each row's `usage` and `limit_usage` are aggregated using the offering's own `limit_period`.
Path parameters:
  - uuid

============================================================
## marketplace-provider-offerings  (module: waldur_api_client.api.marketplace_provider_offerings)
============================================================

### marketplace_provider_offerings_list
GET /api/marketplace-provider-offerings/
Summary: List provider offerings
Description: Returns a paginated list of offerings for the provider.
Query parameters (42):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - field
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - importable — Filter by importable offerings.
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_provider_offerings_count
HEAD /api/marketplace-provider-offerings/
Summary: List provider offerings
Description: Get number of items in the collection matching the request parameters.
Query parameters (41):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - importable — Filter by importable offerings.
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_provider_offerings_create
POST /api/marketplace-provider-offerings/
Summary: Create a provider offering
Description: Creates a new provider offering.
Request body: yes

### marketplace_provider_offerings_groups_list
GET /api/marketplace-provider-offerings/groups/
Summary: List offerings grouped by provider
Description: Returns a paginated list of active, shared offerings grouped by their service provider.
Query parameters (40):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_provider_offerings_groups_count
HEAD /api/marketplace-provider-offerings/groups/
Summary: List offerings grouped by provider
Description: Get number of items in the collection matching the request parameters.
Query parameters (40):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_provider_offerings_import_offering
POST /api/marketplace-provider-offerings/import_offering/
Summary: Import offering data
Description: Imports an offering and all its connected parts from YAML format. Allows configuration of which components to import and how to handle conflicts. Imported offerings are always created in DRAFT state for security.
Request body: yes

### marketplace_provider_offerings_retrieve
GET /api/marketplace-provider-offerings/{uuid}/
Summary: Retrieve a provider offering
Description: Returns details of a specific provider offering.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_provider_offerings_destroy
DELETE /api/marketplace-provider-offerings/{uuid}/
Summary: Delete a provider offering
Description: Deletes a provider offering. Only possible for offerings in a Draft state with no associated resources.
Path parameters:
  - uuid

### marketplace_provider_offerings_activate
POST /api/marketplace-provider-offerings/{uuid}/activate/
Summary: Activate an offering
Description: Activates a draft or paused offering, making it available for ordering.
Path parameters:
  - uuid

### marketplace_provider_offerings_add_endpoint
POST /api/marketplace-provider-offerings/{uuid}/add_endpoint/
Summary: Add an access endpoint to an offering
Description: Adds a new access endpoint (URL) to an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_add_partition
POST /api/marketplace-provider-offerings/{uuid}/add_partition/
Summary: Add a partition to an offering
Description: Adds a new partition configuration to an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_add_software_catalog
POST /api/marketplace-provider-offerings/{uuid}/add_software_catalog/
Summary: Add a software catalog to an offering
Description: Associates a software catalog with an offering and configures enabled CPU architectures.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_add_user
POST /api/marketplace-provider-offerings/{uuid}/add_user/
Summary: Grant a role to a user
Description: Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_archive
POST /api/marketplace-provider-offerings/{uuid}/archive/
Summary: Archive an offering
Description: Archives an offering, making it permanently unavailable for new orders.
Path parameters:
  - uuid

### marketplace_provider_offerings_check_unique_backend_id
POST /api/marketplace-provider-offerings/{uuid}/check_unique_backend_id/
Summary: Check if backend_id is unique
Description: Checks if the provided backend_id has been used in resources of this offering or all offerings of the same customer. Returns true if unique, false if already used.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_component_stats_list
GET /api/marketplace-provider-offerings/{uuid}/component_stats/
Summary: Get statistics for offering components
Description: Returns monthly usage statistics for the components of an offering within a specified date range.
Path parameters:
  - uuid
Query parameters (43):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - end — End date in format YYYY-MM.
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - importable — Filter by importable offerings.
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - start — Start date in format YYYY-MM.
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_provider_offerings_costs_list
GET /api/marketplace-provider-offerings/{uuid}/costs/
Summary: Get costs for an offering
Description: Returns monthly cost data for an offering within a specified date range.
Path parameters:
  - uuid
Query parameters (44):
  - accessible_via_calls — Accessible via calls
  - accounting_is_running
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - end — End date in format YYYY-MM.
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - importable — Filter by importable offerings.
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - start — Start date in format YYYY-MM.
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_provider_offerings_create_offering_component
POST /api/marketplace-provider-offerings/{uuid}/create_offering_component/
Summary: Create an offering component
Description: Adds a new custom component to an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_customers_list
GET /api/marketplace-provider-offerings/{uuid}/customers/
Summary: Get customers for an offering
Description: Returns a paginated list of customers who have resources for this offering.
Path parameters:
  - uuid
Query parameters (42):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - field
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - importable — Filter by importable offerings.
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_provider_offerings_delete_user_attribute_config_destroy
DELETE /api/marketplace-provider-offerings/{uuid}/delete-user-attribute-config/
Summary: Delete user attribute config
Description: Deletes the user attribute configuration for this offering. The offering will fall back to system defaults.
Path parameters:
  - uuid

### marketplace_provider_offerings_delete_endpoint
POST /api/marketplace-provider-offerings/{uuid}/delete_endpoint/
Summary: Delete an access endpoint from an offering
Description: Deletes an existing access endpoint from an offering by its UUID.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_delete_image
POST /api/marketplace-provider-offerings/{uuid}/delete_image/
Summary: Delete offering image
Description: Deletes the main image of an offering.
Path parameters:
  - uuid

### marketplace_provider_offerings_delete_organization_groups
POST /api/marketplace-provider-offerings/{uuid}/delete_organization_groups/
Summary: Delete organization groups for offering
Description: Removes all organization group associations from this offering, making it accessible to all.
Path parameters:
  - uuid

### marketplace_provider_offerings_delete_tags
POST /api/marketplace-provider-offerings/{uuid}/delete_tags/
Summary: Delete tags for offering
Description: Removes all tag associations from this offering.
Path parameters:
  - uuid

### marketplace_provider_offerings_delete_thumbnail
POST /api/marketplace-provider-offerings/{uuid}/delete_thumbnail/
Summary: Delete offering thumbnail
Description: Deletes the thumbnail image of an offering.
Path parameters:
  - uuid

### marketplace_provider_offerings_delete_user
POST /api/marketplace-provider-offerings/{uuid}/delete_user/
Summary: Revoke a role from a user
Description: Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_draft
POST /api/marketplace-provider-offerings/{uuid}/draft/
Summary: Move an offering to draft
Description: Moves an active or paused offering back to the draft state for editing.
Path parameters:
  - uuid

### marketplace_provider_offerings_effective_posix_id_pool_retrieve
GET /api/marketplace-provider-offerings/{uuid}/effective_posix_id_pool/
Summary: Effective POSIX ID pool
Description: The POSIX ID pool that governs this offering: its own override pool if present, otherwise the service provider's default pool. Returns null when no pool is configured.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_provider_offerings_export_offering
POST /api/marketplace-provider-offerings/{uuid}/export_offering/
Summary: Export offering data
Description: Exports an offering and all its connected parts to YAML format. Allows configuration of which components to include in the export.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_glauth_tree_retrieve
GET /api/marketplace-provider-offerings/{uuid}/glauth_tree/
Summary: Get structured GLauth tree for an offering
Description: Returns the same set of users, groups and robot accounts as `glauth_users_config`, but as a structured JSON tree suitable for navigation in admin UIs. Source of truth for the TOML endpoint.
Path parameters:
  - uuid

### marketplace_provider_offerings_glauth_users_config_retrieve
GET /api/marketplace-provider-offerings/{uuid}/glauth_users_config/
Summary: Get GLauth user configuration
Description: This endpoint provides a configuration file for GLauth.
        It is intended to be used by an external agent to synchronize user data from Waldur to GLauth.

        Example output format:
        ```
        [[users]]
          name = "johndoe"
          givenname="John"
          sn="Doe"
   ...
Path parameters:
  - uuid

### marketplace_provider_offerings_history_list
GET /api/marketplace-provider-offerings/{uuid}/history/
Summary: Get version history
Description: Returns the version history for this object. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (42):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_after — Filter versions created after this timestamp (ISO 8601)
  - created_before — Filter versions created before this timestamp (ISO 8601)
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - importable — Filter by importable offerings.
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_provider_offerings_history_at_retrieve
GET /api/marketplace-provider-offerings/{uuid}/history/at/
Summary: Get object state at a specific timestamp
Description: Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (1):
  - timestamp (required) — ISO 8601 timestamp to query the object state at

### marketplace_provider_offerings_import_resource
POST /api/marketplace-provider-offerings/{uuid}/import_resource/
Summary: Import a resource
Description: Imports a backend resource into the marketplace.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_importable_resources_list
GET /api/marketplace-provider-offerings/{uuid}/importable_resources/
Summary: List importable resources
Description: Returns a paginated list of resources that can be imported for this offering.
Path parameters:
  - uuid

### marketplace_provider_offerings_list_course_accounts_list
GET /api/marketplace-provider-offerings/{uuid}/list_course_accounts/
Summary: List course accounts for an offering
Description: Returns a paginated list of course accounts for projects that have resources of this offering.
Path parameters:
  - uuid
Query parameters (41):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - importable — Filter by importable offerings.
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_provider_offerings_list_customer_projects_list
GET /api/marketplace-provider-offerings/{uuid}/list_customer_projects/
Summary: List customer projects for an offering
Description: Returns a paginated list of projects that have consumed resources of this offering.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_provider_offerings_list_customer_service_accounts_list
GET /api/marketplace-provider-offerings/{uuid}/list_customer_service_accounts/
Summary: List customer service accounts for an offering
Description: Returns a paginated list of customer-level service accounts for customers who have resources of this offering.
Path parameters:
  - uuid
Query parameters (41):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - importable — Filter by importable offerings.
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_provider_offerings_list_customer_users_list
GET /api/marketplace-provider-offerings/{uuid}/list_customer_users/
Summary: List customer users for an offering
Description: Returns a paginated list of users who have access to resources of this offering.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_provider_offerings_list_project_service_accounts_list
GET /api/marketplace-provider-offerings/{uuid}/list_project_service_accounts/
Summary: List project service accounts for an offering
Description: Returns a paginated list of project-level service accounts for projects that have resources of this offering.
Path parameters:
  - uuid
Query parameters (41):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - importable — Filter by importable offerings.
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_provider_offerings_list_users_list
GET /api/marketplace-provider-offerings/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### marketplace_provider_offerings_list_users_count
HEAD /api/marketplace-provider-offerings/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### marketplace_provider_offerings_make_available
POST /api/marketplace-provider-offerings/{uuid}/make_available/
Summary: Mark an offering as available
Description: Marks an unavailable offering as available.
Path parameters:
  - uuid

### marketplace_provider_offerings_make_unavailable
POST /api/marketplace-provider-offerings/{uuid}/make_unavailable/
Summary: Mark an offering as unavailable
Description: Marks an active offering as unavailable, blocking all operations on its resources.
Path parameters:
  - uuid

### marketplace_provider_offerings_move_offering
POST /api/marketplace-provider-offerings/{uuid}/move_offering/
Summary: Move an offering
Description: Moves an offering to a different service provider. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_orders_list
GET /api/marketplace-provider-offerings/{uuid}/orders/
Summary: List orders for an offering
Description: Returns a paginated list of orders associated with a specific offering.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_provider_offerings_orders_retrieve
GET /api/marketplace-provider-offerings/{uuid}/orders/{order_uuid}/
Summary: Retrieve a specific order for an offering
Description: Returns details of a specific order associated with an offering.
Path parameters:
  - order_uuid
  - uuid
Query parameters (1):
  - field

### marketplace_provider_offerings_pause
POST /api/marketplace-provider-offerings/{uuid}/pause/
Summary: Pause an offering
Description: Pauses an active offering, preventing new orders from being created.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_refresh_offering_usernames
POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/
Summary: Refresh offering user usernames
Description: Triggers a refresh of usernames for all non-restricted users associated with this offering, based on the current username generation policy.
Path parameters:
  - uuid

### marketplace_provider_offerings_remove_offering_component
POST /api/marketplace-provider-offerings/{uuid}/remove_offering_component/
Summary: Remove an offering component
Description: Removes a custom component from an offering. Built-in components cannot be removed.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_remove_partition
POST /api/marketplace-provider-offerings/{uuid}/remove_partition/
Summary: Remove a partition from an offering
Description: Removes a partition configuration from an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_remove_software_catalog
POST /api/marketplace-provider-offerings/{uuid}/remove_software_catalog/
Summary: Remove a software catalog from an offering
Description: Disassociates a software catalog from an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_set_backend_metadata
POST /api/marketplace-provider-offerings/{uuid}/set_backend_metadata/
Summary: Set offering backend metadata
Description: Updates the backend-specific metadata for an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_set_offering_group
POST /api/marketplace-provider-offerings/{uuid}/set_offering_group/
Summary: Assign or clear the offering group
Description: Sets the offering's ``offering_group`` FK. Pass ``offering_group: <uuid>`` to assign a group, or ``offering_group: null`` to clear it. The group must belong to the same customer as the offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_set_profile
POST /api/marketplace-provider-offerings/{uuid}/set_profile/
Summary: Bind / unbind offering to a service profile
Description: Sets the offering's `profile` FK. Pass `profile: <uuid>` to bind, or `profile: null` to unbind. Requires UPDATE_OFFERING permission on the offering's customer (service-provider owners and staff). Triggers async reconciliation of RoleAvailability rows on this offering against the profile's role ca...
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_state_counters_retrieve
GET /api/marketplace-provider-offerings/{uuid}/state_counters/
Summary: Get offering resource and user state counters
Description: Returns resource and offering-user counts grouped by state for the given offering.
Path parameters:
  - uuid

### marketplace_provider_offerings_stats_retrieve
GET /api/marketplace-provider-offerings/{uuid}/stats/
Summary: Get offering statistics
Description: Returns basic statistics for an offering, such as the number of active resources and customers.
Path parameters:
  - uuid

### marketplace_provider_offerings_switch_billing_mode
POST /api/marketplace-provider-offerings/{uuid}/switch_billing_mode/
Summary: Switch billing mode for builtin components
Description: Switches all builtin components between monthly (LIMIT), prepaid (ONE_TIME + is_prepaid), and usage-based billing modes. Works for any offering type that has registered builtin components.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_sync
POST /api/marketplace-provider-offerings/{uuid}/sync/
Summary: Synchronize offering service settings
Description: Schedules a synchronization task to pull the latest data for the offering's service settings from the backend.
Path parameters:
  - uuid

### marketplace_provider_offerings_sync_resources
POST /api/marketplace-provider-offerings/{uuid}/sync_resources/
Summary: Synchronize offering resources
Description: Requests connected site agents to run a full reconciliation of all resources belonging to this offering: recreate missing backend accounts, restore user associations and re-apply resource limits. Useful when the provider backend has lost state, e.g. a wiped SLURM database.
Path parameters:
  - uuid

### marketplace_provider_offerings_tos_stats_retrieve
GET /api/marketplace-provider-offerings/{uuid}/tos_stats/
Summary: Get Terms of Service consent statistics
Description: Returns comprehensive Terms of Service consent statistics for this offering, including user counts, consent rates, and historical data.
Path parameters:
  - uuid

### marketplace_provider_offerings_unpause
POST /api/marketplace-provider-offerings/{uuid}/unpause/
Summary: Unpause an offering
Description: Resumes a paused offering, making it available for ordering again.
Path parameters:
  - uuid

### marketplace_provider_offerings_update_user_attribute_config
POST /api/marketplace-provider-offerings/{uuid}/update-user-attribute-config/
Summary: Update user attribute config
Description: Creates or updates the user attribute configuration for this offering. This determines which user attributes are shared with the service provider.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_user_attribute_config_update
PUT /api/marketplace-provider-offerings/{uuid}/update-user-attribute-config/
Summary: Update user attribute config
Description: Creates or updates the user attribute configuration for this offering. This determines which user attributes are shared with the service provider.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_user_attribute_config_partial_update
PATCH /api/marketplace-provider-offerings/{uuid}/update-user-attribute-config/
Summary: Update user attribute config
Description: Creates or updates the user attribute configuration for this offering. This determines which user attributes are shared with the service provider.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_attributes
POST /api/marketplace-provider-offerings/{uuid}/update_attributes/
Summary: Update offering attributes
Description: Updates the attributes of an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_backend_id_rules
POST /api/marketplace-provider-offerings/{uuid}/update_backend_id_rules/
Summary: Update offering backend_id rules
Description: Configure validation rules for resource backend_id: format regex and uniqueness scope.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_compliance_checklist
POST /api/marketplace-provider-offerings/{uuid}/update_compliance_checklist/
Summary: Update offering compliance checklist
Description: Associates a compliance checklist with an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_description
POST /api/marketplace-provider-offerings/{uuid}/update_description/
Summary: Update offering category
Description: Updates the category of an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_image
POST /api/marketplace-provider-offerings/{uuid}/update_image/
Summary: Update offering image
Description: Uploads or replaces the main image for an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_integration
POST /api/marketplace-provider-offerings/{uuid}/update_integration/
Summary: Update offering integration settings
Description: Updates the backend integration settings for an offering, including plugin options, secret options, and service attributes.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_location
POST /api/marketplace-provider-offerings/{uuid}/update_location/
Summary: Update offering location
Description: Updates the geographical location (latitude and longitude) of an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_offering_component
POST /api/marketplace-provider-offerings/{uuid}/update_offering_component/
Summary: Update an offering component
Description: Updates the properties of a specific component within an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_options
POST /api/marketplace-provider-offerings/{uuid}/update_options/
Summary: Update offering options
Description: Updates the order form options for an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_organization_groups
POST /api/marketplace-provider-offerings/{uuid}/update_organization_groups/
Summary: Update organization groups for offering
Description: Sets the list of organization groups that can access this offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_overview
POST /api/marketplace-provider-offerings/{uuid}/update_overview/
Summary: Update offering overview
Description: Updates the overview fields of an offering, such as name, description, and getting started guide.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_partition_partial_update
PATCH /api/marketplace-provider-offerings/{uuid}/update_partition/
Summary: Update a partition of an offering
Description: Updates the configuration of an existing partition associated with an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_resource_options
POST /api/marketplace-provider-offerings/{uuid}/update_resource_options/
Summary: Update offering resource options
Description: Updates the resource report form options for an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_software_catalog_partial_update
PATCH /api/marketplace-provider-offerings/{uuid}/update_software_catalog/
Summary: Update software catalog configuration
Description: Updates the configuration of a software catalog associated with an offering, such as enabled architectures or partition.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_tags
POST /api/marketplace-provider-offerings/{uuid}/update_tags/
Summary: Update tags for offering
Description: Sets the list of tags for this offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_thumbnail
POST /api/marketplace-provider-offerings/{uuid}/update_thumbnail/
Summary: Update offering thumbnail
Description: Uploads or replaces the thumbnail image for an offering.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_type
POST /api/marketplace-provider-offerings/{uuid}/update_type/
Summary: Swap offering type
Description: Changes the offering's `type` between Marketplace.Basic and the site-agent type (Marketplace.Slurm). Both plugins share the same data shape (the site-agent processors inherit from Basic and only delegate the send paths to the external agent), so the swap is safe in either direction. Refused if th...
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_update_user
POST /api/marketplace-provider-offerings/{uuid}/update_user/
Summary: Update a user's role expiration
Description: Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_upload_markdown_image
POST /api/marketplace-provider-offerings/{uuid}/upload_markdown_image/
Summary: Upload markdown image
Description: Uploads an image for embedding in offering markdown descriptions. Requires ENABLE_MARKDOWN_IMAGE_UPLOAD Constance setting.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_offerings_user_attribute_config_retrieve
GET /api/marketplace-provider-offerings/{uuid}/user-attribute-config/
Summary: Get user attribute config
Description: Returns the user attribute configuration for this offering, which determines which user attributes are exposed to the service provider.
Path parameters:
  - uuid

### marketplace_provider_offerings_user_has_resource_access_retrieve
GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/
Summary: Check user access to offering resources
Description: Checks if a specified user has access to any non-terminated resource of this offering.
Path parameters:
  - uuid
Query parameters (1):
  - username (required) — Username of the user to check.

============================================================
## marketplace-provider-resource-projects  (module: waldur_api_client.api.marketplace_provider_resource_projects)
============================================================

### marketplace_provider_resource_projects_list
GET /api/marketplace-provider-resource-projects/
Query parameters (3):
  - name
  - resource — Resource URL
  - resource_uuid — Resource UUID

### marketplace_provider_resource_projects_count
HEAD /api/marketplace-provider-resource-projects/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - name
  - resource — Resource URL
  - resource_uuid — Resource UUID

### marketplace_provider_resource_projects_retrieve
GET /api/marketplace-provider-resource-projects/{uuid}/
Path parameters:
  - uuid

### marketplace_provider_resource_projects_update
PUT /api/marketplace-provider-resource-projects/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resource_projects_partial_update
PATCH /api/marketplace-provider-resource-projects/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resource_projects_add_user
POST /api/marketplace-provider-resource-projects/{uuid}/add_user/
Summary: Grant a role to a user
Description: Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resource_projects_delete_user
POST /api/marketplace-provider-resource-projects/{uuid}/delete_user/
Summary: Revoke a role from a user
Description: Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resource_projects_list_users_list
GET /api/marketplace-provider-resource-projects/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### marketplace_provider_resource_projects_list_users_count
HEAD /api/marketplace-provider-resource-projects/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### marketplace_provider_resource_projects_set_backend_id
POST /api/marketplace-provider-resource-projects/{uuid}/set_backend_id/
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resource_projects_set_state_erred
POST /api/marketplace-provider-resource-projects/{uuid}/set_state_erred/
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resource_projects_set_state_ok
POST /api/marketplace-provider-resource-projects/{uuid}/set_state_ok/
Path parameters:
  - uuid

### marketplace_provider_resource_projects_update_user
POST /api/marketplace-provider-resource-projects/{uuid}/update_user/
Summary: Update a user's role expiration
Description: Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-provider-resources  (module: waldur_api_client.api.marketplace_provider_resources)
============================================================

### marketplace_provider_resources_list
GET /api/marketplace-provider-resources/
Summary: List provider resources
Description: Returns a paginated list of resources for offerings managed by the current user as a service provider.
Query parameters (47):
  - backend_id — Backend ID
  - category_uuid — Category UUID
  - component_count — Filter by exact number of components
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - downscaled — Downscaled
  - field
  - flavor_name — Flavor name
  - has_terminate_date — Has termination date
  - image_name — Image name
  - is_attached — Filter by attached state
  - lexis_links_supported — LEXIS links supported
  - limit_based — Filter by limit-based offerings
  - limit_component_count — Filter by exact number of limit-based components
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering
  - offering_billable — Offering billable
  - offering_shared — Offering shared
  - offering_slug — Multiple values may be separated by commas.
  - offering_type — Offering type
  - offering_uuid — Multiple values may be separated by commas.
  - only_limit_based — Filter resources with only limit-based components
  - only_usage_based — Filter resources with only usage-based components
  - order_state — Order state
  - parent_offering_uuid
  - paused — Paused
  - plan_uuid — Plan UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - query — Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
  - resource_attributes — Resource attributes (JSON)
  - restrict_member_access — Restrict member access
  - runtime_state — Runtime state
  - scope — Filter by scope URL.
  - service_manager_uuid — Service manager UUID
  - slug — Slug
  - state — Resource state
  - usage_based — Filter by usage-based offerings
  - visible_to_providers — Include only resources visible to service providers
  - visible_to_username — Visible to username

### marketplace_provider_resources_count
HEAD /api/marketplace-provider-resources/
Summary: List provider resources
Description: Get number of items in the collection matching the request parameters.
Query parameters (46):
  - backend_id — Backend ID
  - category_uuid — Category UUID
  - component_count — Filter by exact number of components
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - downscaled — Downscaled
  - flavor_name — Flavor name
  - has_terminate_date — Has termination date
  - image_name — Image name
  - is_attached — Filter by attached state
  - lexis_links_supported — LEXIS links supported
  - limit_based — Filter by limit-based offerings
  - limit_component_count — Filter by exact number of limit-based components
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering
  - offering_billable — Offering billable
  - offering_shared — Offering shared
  - offering_slug — Multiple values may be separated by commas.
  - offering_type — Offering type
  - offering_uuid — Multiple values may be separated by commas.
  - only_limit_based — Filter resources with only limit-based components
  - only_usage_based — Filter resources with only usage-based components
  - order_state — Order state
  - parent_offering_uuid
  - paused — Paused
  - plan_uuid — Plan UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - query — Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
  - resource_attributes — Resource attributes (JSON)
  - restrict_member_access — Restrict member access
  - runtime_state — Runtime state
  - scope — Filter by scope URL.
  - service_manager_uuid — Service manager UUID
  - slug — Slug
  - state — Resource state
  - usage_based — Filter by usage-based offerings
  - visible_to_providers — Include only resources visible to service providers
  - visible_to_username — Visible to username

### marketplace_provider_resources_retrieve
GET /api/marketplace-provider-resources/{uuid}/
Summary: Retrieve a provider resource
Description: Returns details of a specific resource from a provider's perspective.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_provider_resources_update
PUT /api/marketplace-provider-resources/{uuid}/
Summary: Update a provider resource
Description: Updates the name or description of a resource. Requires provider permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_partial_update
PATCH /api/marketplace-provider-resources/{uuid}/
Summary: Partially update a provider resource
Description: Partially updates the name or description of a resource. Requires provider permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_add_user
POST /api/marketplace-provider-resources/{uuid}/add_user/
Summary: Grant a role to a user
Description: Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_adjust_dates
POST /api/marketplace-provider-resources/{uuid}/adjust_dates/
Summary: Adjust resource start and end dates (staff only)
Description: Updates both the originating order's start_date and the resource's end_date in one atomic operation. Intended for helpdesk-style prepaid offerings where staff need to shift the service window forward. Does not regenerate invoices, issue credits, or send notifications.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_delete_user
POST /api/marketplace-provider-resources/{uuid}/delete_user/
Summary: Revoke a role from a user
Description: Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_details_retrieve
GET /api/marketplace-provider-resources/{uuid}/details/
Summary: Get resource details
Description: Returns the detailed representation of the backend resource associated with the marketplace resource. The format of the response depends on the resource type.
Path parameters:
  - uuid

### marketplace_provider_resources_glauth_tree_retrieve
GET /api/marketplace-provider-resources/{uuid}/glauth_tree/
Summary: Get structured GLauth tree for a resource
Description: Structured JSON tree (offering, groups, users, robot accounts) scoped to one resource's project. Source of truth for the `glauth_users_config` TOML on this viewset.
Path parameters:
  - uuid

### marketplace_provider_resources_glauth_users_config_retrieve
GET /api/marketplace-provider-resources/{uuid}/glauth_users_config/
Summary: Get GLauth user configuration for a resource
Description: This endpoint provides a GLauth configuration file for the users associated with the project of this resource.
        It is intended for use by an external agent to synchronize user data from Waldur to GLauth.
Path parameters:
  - uuid

### marketplace_provider_resources_history_list
GET /api/marketplace-provider-resources/{uuid}/history/
Summary: Get version history
Description: Returns the version history for this object. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (47):
  - backend_id — Backend ID
  - category_uuid — Category UUID
  - component_count — Filter by exact number of components
  - created — Created after
  - created_after — Filter versions created after this timestamp (ISO 8601)
  - created_before — Filter versions created before this timestamp (ISO 8601)
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - downscaled — Downscaled
  - flavor_name — Flavor name
  - has_terminate_date — Has termination date
  - image_name — Image name
  - is_attached — Filter by attached state
  - lexis_links_supported — LEXIS links supported
  - limit_based — Filter by limit-based offerings
  - limit_component_count — Filter by exact number of limit-based components
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering
  - offering_billable — Offering billable
  - offering_shared — Offering shared
  - offering_slug — Multiple values may be separated by commas.
  - offering_type — Offering type
  - offering_uuid — Multiple values may be separated by commas.
  - only_limit_based — Filter resources with only limit-based components
  - only_usage_based — Filter resources with only usage-based components
  - order_state — Order state
  - parent_offering_uuid
  - paused — Paused
  - plan_uuid — Plan UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - query — Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
  - resource_attributes — Resource attributes (JSON)
  - restrict_member_access — Restrict member access
  - runtime_state — Runtime state
  - scope — Filter by scope URL.
  - service_manager_uuid — Service manager UUID
  - slug — Slug
  - state — Resource state
  - usage_based — Filter by usage-based offerings
  - visible_to_providers — Include only resources visible to service providers
  - visible_to_username — Visible to username

### marketplace_provider_resources_history_at_retrieve
GET /api/marketplace-provider-resources/{uuid}/history/at/
Summary: Get object state at a specific timestamp
Description: Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (1):
  - timestamp (required) — ISO 8601 timestamp to query the object state at

### marketplace_provider_resources_list_users_list
GET /api/marketplace-provider-resources/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### marketplace_provider_resources_list_users_count
HEAD /api/marketplace-provider-resources/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### marketplace_provider_resources_move_resource
POST /api/marketplace-provider-resources/{uuid}/move_resource/
Summary: Move a resource to another project
Description: Moves a resource and its associated data to a different project. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_offering_retrieve
GET /api/marketplace-provider-resources/{uuid}/offering/
Summary: Get offering details
Description: Returns details of the offering connected to the requested object.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_provider_resources_offering_for_subresources_list
GET /api/marketplace-provider-resources/{uuid}/offering_for_subresources/
Summary: List offerings for sub-resources
Description: Returns a list of offerings that can be provisioned as sub-resources of the current resource.
Path parameters:
  - uuid

### marketplace_provider_resources_plan_periods_list
GET /api/marketplace-provider-resources/{uuid}/plan_periods/
Summary: List resource plan periods
Description: Returns a list of active and future plan periods for the resource. Each period includes the plan details and current component usage.
Path parameters:
  - uuid

### marketplace_provider_resources_pull
POST /api/marketplace-provider-resources/{uuid}/pull/
Summary: Pull resource data
Description: Schedules a task to pull the latest data for the resource from its backend.
Path parameters:
  - uuid

### marketplace_provider_resources_refresh_last_sync
POST /api/marketplace-provider-resources/{uuid}/refresh_last_sync/
Summary: Refresh last sync time
Description: Updates the 'last_sync' timestamp for a resource to the current time. This is useful for backend agents to signal that a resource is being actively monitored.
Path parameters:
  - uuid

### marketplace_provider_resources_restore
POST /api/marketplace-provider-resources/{uuid}/restore/
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_as_erred
POST /api/marketplace-provider-resources/{uuid}/set_as_erred/
Summary: Set resource state to erred
Description: Allows a service provider to manually set the state of a resource to 'erred'. An error message and traceback can be provided.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_as_ok
POST /api/marketplace-provider-resources/{uuid}/set_as_ok/
Summary: Set resource state to OK
Description: Allows a service provider to manually set the state of a resource to 'OK', clearing any previous error messages.
Path parameters:
  - uuid

### marketplace_provider_resources_set_backend_id
POST /api/marketplace-provider-resources/{uuid}/set_backend_id/
Summary: Set resource backend ID
Description: Allows a service provider to set or update the backend ID for a resource, linking it to an external system's identifier.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_backend_metadata
POST /api/marketplace-provider-resources/{uuid}/set_backend_metadata/
Summary: Set resource backend metadata
Description: Allows a service provider to set or update the backend-specific metadata for a resource.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_downscaled
POST /api/marketplace-provider-resources/{uuid}/set_downscaled/
Summary: Set downscaled flag for resource
Description: Sets the 'downscaled' flag for a resource. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_effective_id
POST /api/marketplace-provider-resources/{uuid}/set_effective_id/
Summary: Set resource effective ID
Description: Allows a service provider to set or update the effective ID for a resource. The effective ID represents the backend identifier assigned by a downstream provider in federated Waldur deployments.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_end_date
POST /api/marketplace-provider-resources/{uuid}/set_end_date/
Summary: Set end date of the resource
Description: Allows a service provider to set or update the end date for a resource.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_end_date_by_provider
POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/
Summary: Set end date by provider
Description: Deprecated: Use set_end_date instead. Allows a service provider to set or update the end date for a resource.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_end_date_by_staff
POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_staff/
Summary: Set end date of the resource by staff
Description: Deprecated: Use set_end_date instead. Allows a staff user to set or update the end date for a resource.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_endpoints
POST /api/marketplace-provider-resources/{uuid}/set_endpoints/
Summary: Set resource access endpoints
Description: Allows a service provider to replace the set of access endpoints (name + URL) reported for a resource. Used to surface dynamic per-resource endpoints (e.g. an inference API) in the UI.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_limits
POST /api/marketplace-provider-resources/{uuid}/set_limits/
Summary: Set resource limits
Description: Allows a service provider to directly set the limits for a resource. This is typically used for administrative changes or backend synchronization, bypassing the normal order process.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_paused
POST /api/marketplace-provider-resources/{uuid}/set_paused/
Summary: Set paused flag for resource
Description: Sets the 'paused' flag for a resource. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_restrict_member_access
POST /api/marketplace-provider-resources/{uuid}/set_restrict_member_access/
Summary: Set restrict member access flag
Description: Sets the 'restrict_member_access' flag for a resource. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_slug
POST /api/marketplace-provider-resources/{uuid}/set_slug/
Summary: Set resource slug
Description: Updates the slug for a resource. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_set_state_ok
POST /api/marketplace-provider-resources/{uuid}/set_state_ok/
Summary: Set resource state to OK
Description: Allows a service provider to manually set the resource state to OK. This is useful for recovering from Erred state.
Path parameters:
  - uuid

### marketplace_provider_resources_submit_report
POST /api/marketplace-provider-resources/{uuid}/submit_report/
Summary: Submit a report for a resource
Description: Allows a service provider to submit a report (e.g., usage or status report) for a resource.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_team_list
GET /api/marketplace-provider-resources/{uuid}/team/
Summary: Get resource team
Description: Returns project users for this resource from the service provider perspective. When ENFORCE_USER_CONSENT_FOR_OFFERINGS is enabled and the offering has active Terms of Service, only users with active consent are returned (staff and support still see the full team).
Path parameters:
  - uuid
Query parameters (1):
  - has_consent — When ENFORCE_USER_CONSENT_FOR_OFFERINGS is disabled, passing true returns only users who have active consent for this offering.

### marketplace_provider_resources_terminate
POST /api/marketplace-provider-resources/{uuid}/terminate/
Summary: Terminate a resource
Description: Creates a marketplace order to terminate the resource. This action is asynchronous and may require approval.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_unlink
POST /api/marketplace-provider-resources/{uuid}/unlink/
Summary: Unlink a resource (staff only)
Description: Forcefully deletes a marketplace resource and its related plugin resource from the database. This action does not schedule operations on the backend and is intended for cleaning up resources stuck in transitioning states. Requires staff permissions.
Path parameters:
  - uuid

### marketplace_provider_resources_update_options
POST /api/marketplace-provider-resources/{uuid}/update_options/
Summary: Update resource options
Description: Updates the options of a resource. If the offering is configured to create orders for option changes, a new UPDATE order will be created. Otherwise, the options are updated directly.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_update_options_direct
POST /api/marketplace-provider-resources/{uuid}/update_options_direct/
Summary: Update resource options directly
Description: Allows a service provider to directly update the options of a resource without creating an order. This is typically used for administrative changes or backend synchronization.
Path parameters:
  - uuid
Request body: yes

### marketplace_provider_resources_update_user
POST /api/marketplace-provider-resources/{uuid}/update_user/
Summary: Update a user's role expiration
Description: Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-public-api  (module: waldur_api_client.api.marketplace_public_api)
============================================================

### marketplace_public_api_check_signature
POST /api/marketplace-public-api/check_signature/
Summary: Check service provider signature
Description: Validates a signed payload from a service provider. The payload is a JWT token
        signed with the provider's API secret code. This endpoint is used to verify the
        authenticity of a request before processing it.

        The `data` field should contain the JWT token.
Request body: yes

### marketplace_public_api_set_usage
POST /api/marketplace-public-api/set_usage/
Summary: Set component usage with signature
Description: Allows a service provider to report usage for resource components using a signed JWT payload.
        This provides a secure way for external systems to submit billing data.

        The `data` field must contain a JWT token that, when decoded, matches the structure of the
        `ComponentUsage...
Request body: yes

============================================================
## marketplace-public-offerings  (module: waldur_api_client.api.marketplace_public_offerings)
============================================================

### marketplace_public_offerings_list
GET /api/marketplace-public-offerings/
Summary: List public offerings
Description: Returns a paginated list of public offerings. The list is filtered to show only offerings that are active or paused and available for ordering by the current user. If anonymous access is enabled, it shows shared offerings available to unauthenticated users.
Query parameters (41):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - field
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_public_offerings_count
HEAD /api/marketplace-public-offerings/
Summary: List public offerings
Description: Get number of items in the collection matching the request parameters.
Query parameters (40):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_public_offerings_retrieve
GET /api/marketplace-public-offerings/{uuid}/
Summary: Retrieve a public offering
Description: Returns the details of a specific public offering. Access is granted if the offering is available for ordering by the current user or if anonymous access is enabled.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_public_offerings_plans_list
GET /api/marketplace-public-offerings/{uuid}/plans/
Summary: List plans for an offering
Description: Returns a list of plans available for a specific offering. The plans are filtered based on the current user's permissions and organization group memberships.
Path parameters:
  - uuid

### marketplace_public_offerings_plans_retrieve
GET /api/marketplace-public-offerings/{uuid}/plans/{plan_uuid}/
Summary: Retrieve a specific plan for an offering
Description: Returns the details of a specific plan if it is available to the current user for the given offering.
Path parameters:
  - plan_uuid
  - uuid

============================================================
## marketplace-related-customers  (module: waldur_api_client.api.marketplace_related_customers)
============================================================

### marketplace_related_customers_list
GET /api/marketplace-related-customers/{customer_uuid}/
Path parameters:
  - customer_uuid
Query parameters (2):
  - name — Name
  - name_exact — Name (exact)

============================================================
## marketplace-remote-synchronisations  (module: waldur_api_client.api.marketplace_remote_synchronisations)
============================================================

### marketplace_remote_synchronisations_list
GET /api/marketplace-remote-synchronisations/

### marketplace_remote_synchronisations_count
HEAD /api/marketplace-remote-synchronisations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_remote_synchronisations_create
POST /api/marketplace-remote-synchronisations/
Request body: yes

### marketplace_remote_synchronisations_retrieve
GET /api/marketplace-remote-synchronisations/{uuid}/
Path parameters:
  - uuid

### marketplace_remote_synchronisations_update
PUT /api/marketplace-remote-synchronisations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_remote_synchronisations_partial_update
PATCH /api/marketplace-remote-synchronisations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_remote_synchronisations_destroy
DELETE /api/marketplace-remote-synchronisations/{uuid}/
Path parameters:
  - uuid

### marketplace_remote_synchronisations_run_synchronisation
POST /api/marketplace-remote-synchronisations/{uuid}/run_synchronisation/
Path parameters:
  - uuid

============================================================
## marketplace-resource-limit-change-requests  (module: waldur_api_client.api.marketplace_resource_limit_change_requests)
============================================================

### marketplace_resource_limit_change_requests_list
GET /api/marketplace-resource-limit-change-requests/
Query parameters (5):
  - created_by_uuid — Created by UUID
  - customer_uuid — Customer UUID
  - project_uuid — Project UUID
  - resource_uuid — Resource UUID
  - state

### marketplace_resource_limit_change_requests_count
HEAD /api/marketplace-resource-limit-change-requests/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - created_by_uuid — Created by UUID
  - customer_uuid — Customer UUID
  - project_uuid — Project UUID
  - resource_uuid — Resource UUID
  - state

### marketplace_resource_limit_change_requests_create
POST /api/marketplace-resource-limit-change-requests/
Request body: yes

### marketplace_resource_limit_change_requests_retrieve
GET /api/marketplace-resource-limit-change-requests/{uuid}/
Path parameters:
  - uuid

### marketplace_resource_limit_change_requests_approve
POST /api/marketplace-resource-limit-change-requests/{uuid}/approve/
Summary: Approve resource limit change request and apply limits via marketplace order
Description: Approve resource limit change request and apply limits via marketplace order.
Path parameters:
  - uuid
Request body: yes

### marketplace_resource_limit_change_requests_cancel
POST /api/marketplace-resource-limit-change-requests/{uuid}/cancel/
Summary: Cancel resource limit change request
Description: Cancel resource limit change request. Only the creator can cancel.
Path parameters:
  - uuid
Request body: yes

### marketplace_resource_limit_change_requests_reject
POST /api/marketplace-resource-limit-change-requests/{uuid}/reject/
Summary: Reject resource limit change request
Description: Reject resource limit change request.
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-resource-offerings  (module: waldur_api_client.api.marketplace_resource_offerings)
============================================================

### marketplace_resource_offerings_list
GET /api/marketplace-resource-offerings/{category_uuid}/
Path parameters:
  - category_uuid
Query parameters (2):
  - name — Name
  - name_exact — Name (exact)

============================================================
## marketplace-resource-projects  (module: waldur_api_client.api.marketplace_resource_projects)
============================================================

### marketplace_resource_projects_list
GET /api/marketplace-resource-projects/
Query parameters (3):
  - name
  - resource — Resource URL
  - resource_uuid — Resource UUID

### marketplace_resource_projects_count
HEAD /api/marketplace-resource-projects/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - name
  - resource — Resource URL
  - resource_uuid — Resource UUID

### marketplace_resource_projects_create
POST /api/marketplace-resource-projects/
Request body: yes

### marketplace_resource_projects_retrieve
GET /api/marketplace-resource-projects/{uuid}/
Path parameters:
  - uuid

### marketplace_resource_projects_update
PUT /api/marketplace-resource-projects/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_resource_projects_partial_update
PATCH /api/marketplace-resource-projects/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_resource_projects_destroy
DELETE /api/marketplace-resource-projects/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - force — Staff-only: when true, hard-delete the resource project instead of soft-deleting it.

### marketplace_resource_projects_add_user
POST /api/marketplace-resource-projects/{uuid}/add_user/
Summary: Grant a role to a user
Description: Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
Path parameters:
  - uuid
Request body: yes

### marketplace_resource_projects_delete_user
POST /api/marketplace-resource-projects/{uuid}/delete_user/
Summary: Revoke a role from a user
Description: Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
Path parameters:
  - uuid
Request body: yes

### marketplace_resource_projects_list_users_list
GET /api/marketplace-resource-projects/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### marketplace_resource_projects_list_users_count
HEAD /api/marketplace-resource-projects/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### marketplace_resource_projects_recover
POST /api/marketplace-resource-projects/{uuid}/recover/
Summary: Recover a soft-deleted resource project
Description: Flips is_removed back to False on a previously soft-deleted resource project. Optionally restores the team members captured at soft-delete time, or sends them new invitations. Pass ?include_removed=true on the lookup so the soft-deleted row can be resolved.
Path parameters:
  - uuid
Request body: yes

### marketplace_resource_projects_update_user
POST /api/marketplace-resource-projects/{uuid}/update_user/
Summary: Update a user's role expiration
Description: Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-resources  (module: waldur_api_client.api.marketplace_resources)
============================================================

### marketplace_resources_list
GET /api/marketplace-resources/
Summary: List consumer resources
Description: Returns a paginated list of resources accessible to the current user as a service consumer.
Query parameters (47):
  - backend_id — Backend ID
  - category_uuid — Category UUID
  - component_count — Filter by exact number of components
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - downscaled — Downscaled
  - field
  - flavor_name — Flavor name
  - has_terminate_date — Has termination date
  - image_name — Image name
  - is_attached — Filter by attached state
  - lexis_links_supported — LEXIS links supported
  - limit_based — Filter by limit-based offerings
  - limit_component_count — Filter by exact number of limit-based components
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering
  - offering_billable — Offering billable
  - offering_shared — Offering shared
  - offering_slug — Multiple values may be separated by commas.
  - offering_type — Offering type
  - offering_uuid — Multiple values may be separated by commas.
  - only_limit_based — Filter resources with only limit-based components
  - only_usage_based — Filter resources with only usage-based components
  - order_state — Order state
  - parent_offering_uuid
  - paused — Paused
  - plan_uuid — Plan UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - query — Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
  - resource_attributes — Resource attributes (JSON)
  - restrict_member_access — Restrict member access
  - runtime_state — Runtime state
  - scope — Filter by scope URL.
  - service_manager_uuid — Service manager UUID
  - slug — Slug
  - state — Resource state
  - usage_based — Filter by usage-based offerings
  - visible_to_providers — Include only resources visible to service providers
  - visible_to_username — Visible to username

### marketplace_resources_count
HEAD /api/marketplace-resources/
Summary: List consumer resources
Description: Get number of items in the collection matching the request parameters.
Query parameters (46):
  - backend_id — Backend ID
  - category_uuid — Category UUID
  - component_count — Filter by exact number of components
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - downscaled — Downscaled
  - flavor_name — Flavor name
  - has_terminate_date — Has termination date
  - image_name — Image name
  - is_attached — Filter by attached state
  - lexis_links_supported — LEXIS links supported
  - limit_based — Filter by limit-based offerings
  - limit_component_count — Filter by exact number of limit-based components
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering
  - offering_billable — Offering billable
  - offering_shared — Offering shared
  - offering_slug — Multiple values may be separated by commas.
  - offering_type — Offering type
  - offering_uuid — Multiple values may be separated by commas.
  - only_limit_based — Filter resources with only limit-based components
  - only_usage_based — Filter resources with only usage-based components
  - order_state — Order state
  - parent_offering_uuid
  - paused — Paused
  - plan_uuid — Plan UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - query — Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
  - resource_attributes — Resource attributes (JSON)
  - restrict_member_access — Restrict member access
  - runtime_state — Runtime state
  - scope — Filter by scope URL.
  - service_manager_uuid — Service manager UUID
  - slug — Slug
  - state — Resource state
  - usage_based — Filter by usage-based offerings
  - visible_to_providers — Include only resources visible to service providers
  - visible_to_username — Visible to username

### marketplace_resources_suggest_name
POST /api/marketplace-resources/suggest_name/
Summary: Suggest a resource name
Description: Generates a suggested name for a new resource based on the project and offering. If the offering has a `resource_name_pattern` in `plugin_options`, it is used as a Python format string with variables: `{customer_name}`, `{customer_slug}`, `{project_name}`, `{project_slug}`, `{offering_name}`, `{o...
Request body: yes

### marketplace_resources_retrieve
GET /api/marketplace-resources/{uuid}/
Summary: Retrieve a consumer resource
Description: Returns details of a specific resource accessible to the consumer.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_resources_update
PUT /api/marketplace-resources/{uuid}/
Summary: Update a consumer resource
Description: Updates the name, description, or end date of a resource.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_partial_update
PATCH /api/marketplace-resources/{uuid}/
Summary: Partially update a consumer resource
Description: Partially updates the name, description, or end date of a resource.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_add_user
POST /api/marketplace-resources/{uuid}/add_user/
Summary: Grant a role to a user
Description: Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_adjust_dates
POST /api/marketplace-resources/{uuid}/adjust_dates/
Summary: Adjust resource start and end dates (staff only)
Description: Updates both the originating order's start_date and the resource's end_date in one atomic operation. Intended for helpdesk-style prepaid offerings where staff need to shift the service window forward. Does not regenerate invoices, issue credits, or send notifications.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_delete_user
POST /api/marketplace-resources/{uuid}/delete_user/
Summary: Revoke a role from a user
Description: Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_details_retrieve
GET /api/marketplace-resources/{uuid}/details/
Summary: Get resource details
Description: Returns the detailed representation of the backend resource associated with the marketplace resource. The format of the response depends on the resource type.
Path parameters:
  - uuid

### marketplace_resources_estimate_renewal
POST /api/marketplace-resources/{uuid}/estimate_renewal/
Summary: Estimate renewal cost breakdown
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_glauth_tree_retrieve
GET /api/marketplace-resources/{uuid}/glauth_tree/
Summary: Get structured GLauth tree for a resource
Description: Structured JSON tree (offering, groups, users, robot accounts) scoped to one resource's project. Source of truth for the `glauth_users_config` TOML on this viewset.
Path parameters:
  - uuid

### marketplace_resources_glauth_users_config_retrieve
GET /api/marketplace-resources/{uuid}/glauth_users_config/
Summary: Get GLauth user configuration for a resource
Description: This endpoint provides a GLauth configuration file for the users associated with the project of this resource.
        It is intended for use by an external agent to synchronize user data from Waldur to GLauth.
Path parameters:
  - uuid

### marketplace_resources_history_list
GET /api/marketplace-resources/{uuid}/history/
Summary: Get version history
Description: Returns the version history for this object. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (47):
  - backend_id — Backend ID
  - category_uuid — Category UUID
  - component_count — Filter by exact number of components
  - created — Created after
  - created_after — Filter versions created after this timestamp (ISO 8601)
  - created_before — Filter versions created before this timestamp (ISO 8601)
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - downscaled — Downscaled
  - flavor_name — Flavor name
  - has_terminate_date — Has termination date
  - image_name — Image name
  - is_attached — Filter by attached state
  - lexis_links_supported — LEXIS links supported
  - limit_based — Filter by limit-based offerings
  - limit_component_count — Filter by exact number of limit-based components
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering
  - offering_billable — Offering billable
  - offering_shared — Offering shared
  - offering_slug — Multiple values may be separated by commas.
  - offering_type — Offering type
  - offering_uuid — Multiple values may be separated by commas.
  - only_limit_based — Filter resources with only limit-based components
  - only_usage_based — Filter resources with only usage-based components
  - order_state — Order state
  - parent_offering_uuid
  - paused — Paused
  - plan_uuid — Plan UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - query — Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
  - resource_attributes — Resource attributes (JSON)
  - restrict_member_access — Restrict member access
  - runtime_state — Runtime state
  - scope — Filter by scope URL.
  - service_manager_uuid — Service manager UUID
  - slug — Slug
  - state — Resource state
  - usage_based — Filter by usage-based offerings
  - visible_to_providers — Include only resources visible to service providers
  - visible_to_username — Visible to username

### marketplace_resources_history_at_retrieve
GET /api/marketplace-resources/{uuid}/history/at/
Summary: Get object state at a specific timestamp
Description: Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (1):
  - timestamp (required) — ISO 8601 timestamp to query the object state at

### marketplace_resources_list_users_list
GET /api/marketplace-resources/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### marketplace_resources_list_users_count
HEAD /api/marketplace-resources/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### marketplace_resources_move_resource
POST /api/marketplace-resources/{uuid}/move_resource/
Summary: Move a resource to another project
Description: Moves a resource and its associated data to a different project. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_offering_retrieve
GET /api/marketplace-resources/{uuid}/offering/
Summary: Get offering details
Description: Returns details of the offering connected to the requested object.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_resources_offering_for_subresources_list
GET /api/marketplace-resources/{uuid}/offering_for_subresources/
Summary: List offerings for sub-resources
Description: Returns a list of offerings that can be provisioned as sub-resources of the current resource.
Path parameters:
  - uuid

### marketplace_resources_plan_periods_list
GET /api/marketplace-resources/{uuid}/plan_periods/
Summary: List resource plan periods
Description: Returns a list of active and future plan periods for the resource. Each period includes the plan details and current component usage.
Path parameters:
  - uuid

### marketplace_resources_pull
POST /api/marketplace-resources/{uuid}/pull/
Summary: Pull resource data
Description: Schedules a task to pull the latest data for the resource from its backend.
Path parameters:
  - uuid

### marketplace_resources_reallocate_limits
POST /api/marketplace-resources/{uuid}/reallocate_limits/
Summary: Reallocate resource limits
Description: Creates marketplace orders to reallocate limits from source resource to target resources.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_renew
POST /api/marketplace-resources/{uuid}/renew/
Summary: Renew a prepaid resource
Description: Creates a renewal order to extend the subscription period of a prepaid resource. Optionally, limits can be upgraded at the same time.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_restore
POST /api/marketplace-resources/{uuid}/restore/
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_set_downscaled
POST /api/marketplace-resources/{uuid}/set_downscaled/
Summary: Set downscaled flag for resource
Description: Sets the 'downscaled' flag for a resource. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_set_end_date
POST /api/marketplace-resources/{uuid}/set_end_date/
Summary: Set end date of the resource
Description: Allows a consumer (customer owner) to set or update the end date for a resource.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_set_end_date_by_staff
POST /api/marketplace-resources/{uuid}/set_end_date_by_staff/
Summary: Set end date of the resource by staff
Description: Deprecated: Use set_end_date instead. Allows a staff user to set or update the end date for a resource.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_set_paused
POST /api/marketplace-resources/{uuid}/set_paused/
Summary: Set paused flag for resource
Description: Sets the 'paused' flag for a resource. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_set_restrict_member_access
POST /api/marketplace-resources/{uuid}/set_restrict_member_access/
Summary: Set restrict member access flag
Description: Sets the 'restrict_member_access' flag for a resource. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_set_slug
POST /api/marketplace-resources/{uuid}/set_slug/
Summary: Set resource slug
Description: Updates the slug for a resource. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_switch_plan
POST /api/marketplace-resources/{uuid}/switch_plan/
Summary: Switch resource plan
Description: Creates a marketplace order to switch the billing plan for a resource. This action is asynchronous and may require approval.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_team_list
GET /api/marketplace-resources/{uuid}/team/
Summary: Get resource team
Description: Returns project users for this resource, including project roles and offering-specific usernames. Use has_consent=true to list only users with active Terms of Service consent for the offering.
Path parameters:
  - uuid
Query parameters (1):
  - has_consent — When true, return only users who have active consent for this offering.

### marketplace_resources_team_members_list
GET /api/marketplace-resources/{uuid}/team_members/
Summary: List team members of a resource
Description: One row per user (deduplicated) with their direct Resource role and a nested `resource_projects[]` array of their per-ResourceProject grants under this resource. Mirrors the org-level `customers/{uuid}/users/` shape so the frontend can render an expandable per-user view.
Path parameters:
  - uuid
Query parameters (47):
  - backend_id — Backend ID
  - category_uuid — Category UUID
  - component_count — Filter by exact number of components
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - downscaled — Downscaled
  - field
  - flavor_name — Flavor name
  - has_terminate_date — Has termination date
  - image_name — Image name
  - is_attached — Filter by attached state
  - lexis_links_supported — LEXIS links supported
  - limit_based — Filter by limit-based offerings
  - limit_component_count — Filter by exact number of limit-based components
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering
  - offering_billable — Offering billable
  - offering_shared — Offering shared
  - offering_slug — Multiple values may be separated by commas.
  - offering_type — Offering type
  - offering_uuid — Multiple values may be separated by commas.
  - only_limit_based — Filter resources with only limit-based components
  - only_usage_based — Filter resources with only usage-based components
  - order_state — Order state
  - parent_offering_uuid
  - paused — Paused
  - plan_uuid — Plan UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - query — Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
  - resource_attributes — Resource attributes (JSON)
  - restrict_member_access — Restrict member access
  - runtime_state — Runtime state
  - scope — Filter by scope URL.
  - service_manager_uuid — Service manager UUID
  - slug — Slug
  - state — Resource state
  - usage_based — Filter by usage-based offerings
  - visible_to_providers — Include only resources visible to service providers
  - visible_to_username — Visible to username

### marketplace_resources_terminate
POST /api/marketplace-resources/{uuid}/terminate/
Summary: Terminate a resource
Description: Creates a marketplace order to terminate the resource. This action is asynchronous and may require approval.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_unlink
POST /api/marketplace-resources/{uuid}/unlink/
Summary: Unlink a resource (staff only)
Description: Forcefully deletes a marketplace resource and its related plugin resource from the database. This action does not schedule operations on the backend and is intended for cleaning up resources stuck in transitioning states. Requires staff permissions.
Path parameters:
  - uuid

### marketplace_resources_update_limits
POST /api/marketplace-resources/{uuid}/update_limits/
Summary: Update resource limits
Description: Creates a marketplace order to update the limits (e.g., CPU, RAM) for a resource. This action is asynchronous and may require approval.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_update_options
POST /api/marketplace-resources/{uuid}/update_options/
Summary: Update resource options
Description: Updates the options of a resource. If the offering is configured to create orders for option changes, a new UPDATE order will be created. Otherwise, the options are updated directly.
Path parameters:
  - uuid
Request body: yes

### marketplace_resources_update_user
POST /api/marketplace-resources/{uuid}/update_user/
Summary: Update a user's role expiration
Description: Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-robot-accounts  (module: waldur_api_client.api.marketplace_robot_accounts)
============================================================

### marketplace_robot_accounts_list
GET /api/marketplace-robot-accounts/
Summary: List robot accounts
Description: Returns a paginated list of robot accounts accessible to the current user.
Query parameters (15):
  - created — Created after
  - created_before — Created before
  - customer_uuid — Customer UUID
  - field
  - modified — Modified after
  - modified_before — Modified before
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - resource — Resource URL
  - resource_uuid — Resource UUID
  - responsible_user_uuid — Responsible user UUID
  - state — Robot account state
  - type
  - user_email — Connected user email contains
  - username — Username contains

### marketplace_robot_accounts_count
HEAD /api/marketplace-robot-accounts/
Summary: List robot accounts
Description: Get number of items in the collection matching the request parameters.
Query parameters (14):
  - created — Created after
  - created_before — Created before
  - customer_uuid — Customer UUID
  - modified — Modified after
  - modified_before — Modified before
  - project_uuid — Project UUID
  - provider_uuid — Provider UUID
  - resource — Resource URL
  - resource_uuid — Resource UUID
  - responsible_user_uuid — Responsible user UUID
  - state — Robot account state
  - type
  - user_email — Connected user email contains
  - username — Username contains

### marketplace_robot_accounts_create
POST /api/marketplace-robot-accounts/
Summary: Create a robot account
Description: Creates a new robot account for a specific resource. This is typically used for automated access to a resource, e.g., for CI/CD pipelines.
Request body: yes

### marketplace_robot_accounts_retrieve
GET /api/marketplace-robot-accounts/{uuid}/
Summary: Retrieve a robot account
Description: Returns the details of a specific robot account.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_robot_accounts_update
PUT /api/marketplace-robot-accounts/{uuid}/
Summary: Update a robot account
Description: Updates the properties of a robot account, such as its username or associated users. Not allowed for synchronized remote accounts.
Path parameters:
  - uuid
Request body: yes

### marketplace_robot_accounts_partial_update
PATCH /api/marketplace-robot-accounts/{uuid}/
Summary: Partially update a robot account
Description: Partially updates the properties of a robot account. Not allowed for synchronized remote accounts.
Path parameters:
  - uuid
Request body: yes

### marketplace_robot_accounts_destroy
DELETE /api/marketplace-robot-accounts/{uuid}/
Summary: Delete a robot account
Description: Deletes a robot account. This is a hard delete and should be used with caution.
Path parameters:
  - uuid

### marketplace_robot_accounts_set_state_creating
POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/
Summary: Set robot account state to creating
Description: Transitions the robot account state from 'Requested' to 'Creating'. This is typically used by an agent to signal that the creation process has started.
Path parameters:
  - uuid

### marketplace_robot_accounts_set_state_deleted
POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/
Summary: Set robot account state to deleted
Description: Transitions the robot account state from 'Requested deletion' to 'Deleted', marking the successful completion of the deletion process.
Path parameters:
  - uuid

### marketplace_robot_accounts_set_state_erred
POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/
Summary: Set robot account state to erred
Description: Manually moves the robot account into the 'Error' state. An optional error message can be provided.
Path parameters:
  - uuid
Request body: yes

### marketplace_robot_accounts_set_state_ok
POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/
Summary: Set robot account state to OK
Description: Manually sets the robot account state to 'OK', indicating that it is fully operational. This can be used to recover from an error state.
Path parameters:
  - uuid

### marketplace_robot_accounts_set_state_request_deletion
POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/
Summary: Request deletion of a robot account
Description: Transitions the robot account state from 'OK' to 'Requested deletion', initiating the deletion process.
Path parameters:
  - uuid

============================================================
## marketplace-runtime-states  (module: waldur_api_client.api.marketplace_runtime_states)
============================================================

### marketplace_runtime_states_list
GET /api/marketplace-runtime-states/
Summary: List available runtime states for resources
Description: Returns a unique, sorted list of runtime states for all resources accessible to the current user.
        The runtime state is a backend-specific state of a resource (e.g., 'ACTIVE', 'SHUTOFF' for a VM).
        This endpoint is useful for building dynamic filters in a user interface.
        The...
Query parameters (2):
  - category_uuid — Filter runtime states by resources belonging to a specific category.
  - project_uuid — Filter runtime states by resources within a specific project.

============================================================
## marketplace-screenshots  (module: waldur_api_client.api.marketplace_screenshots)
============================================================

### marketplace_screenshots_list
GET /api/marketplace-screenshots/
Query parameters (5):
  - o — Ordering
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Multiple values may be separated by commas.
  - parent_offering_uuid

### marketplace_screenshots_count
HEAD /api/marketplace-screenshots/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - o — Ordering
  - offering
  - offering_slug — Multiple values may be separated by commas.
  - offering_uuid — Multiple values may be separated by commas.
  - parent_offering_uuid

### marketplace_screenshots_create
POST /api/marketplace-screenshots/
Request body: yes

### marketplace_screenshots_retrieve
GET /api/marketplace-screenshots/{uuid}/
Path parameters:
  - uuid

### marketplace_screenshots_update
PUT /api/marketplace-screenshots/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_screenshots_partial_update
PATCH /api/marketplace-screenshots/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_screenshots_destroy
DELETE /api/marketplace-screenshots/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-script-async-dry-run  (module: waldur_api_client.api.marketplace_script_async_dry_run)
============================================================

### marketplace_script_async_dry_run_list
GET /api/marketplace-script-async-dry-run/

### marketplace_script_async_dry_run_count
HEAD /api/marketplace-script-async-dry-run/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_script_async_dry_run_retrieve
GET /api/marketplace-script-async-dry-run/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-script-dry-run  (module: waldur_api_client.api.marketplace_script_dry_run)
============================================================

### marketplace_script_dry_run_async_run
POST /api/marketplace-script-dry-run/{uuid}/async_run/
Path parameters:
  - uuid
Request body: yes

### marketplace_script_dry_run_run
POST /api/marketplace-script-dry-run/{uuid}/run/
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-script-sync-resource  (module: waldur_api_client.api.marketplace_script_sync_resource)
============================================================

### marketplace_script_sync_resource
POST /api/marketplace-script-sync-resource/
Summary: This view allows a user to trigger a pull operation for a marketplace script resource.
        The user must be a service consumer and have access to the resource.
        The pull operation is performed asynchronously using Celery.
Description: Pull a marketplace script resource.
Request body: yes

============================================================
## marketplace-sections  (module: waldur_api_client.api.marketplace_sections)
============================================================

### marketplace_sections_list
GET /api/marketplace-sections/
Summary: List sections
Description: Returns a paginated list of all sections. Sections are used to group attributes within a category.

### marketplace_sections_count
HEAD /api/marketplace-sections/
Summary: List sections
Description: Get number of items in the collection matching the request parameters.

### marketplace_sections_create
POST /api/marketplace-sections/
Summary: Create a section
Description: Creates a new section within a category. Requires staff permissions.
Request body: yes

### marketplace_sections_retrieve
GET /api/marketplace-sections/{key}/
Summary: Retrieve a section
Description: Returns the details of a specific section, identified by its key.
Path parameters:
  - key — A unique value identifying this section.

### marketplace_sections_update
PUT /api/marketplace-sections/{key}/
Summary: Update a section
Description: Updates an existing section. Requires staff permissions.
Path parameters:
  - key — A unique value identifying this section.
Request body: yes

### marketplace_sections_partial_update
PATCH /api/marketplace-sections/{key}/
Summary: Partially update a section
Description: Partially updates an existing section. Requires staff permissions.
Path parameters:
  - key — A unique value identifying this section.
Request body: yes

### marketplace_sections_destroy
DELETE /api/marketplace-sections/{key}/
Summary: Delete a section
Description: Deletes a section. Requires staff permissions.
Path parameters:
  - key — A unique value identifying this section.

============================================================
## marketplace-service-providers  (module: waldur_api_client.api.marketplace_service_providers)
============================================================

### marketplace_service_providers_list
GET /api/marketplace-service-providers/
Summary: List service providers
Description: Returns a paginated list of service providers.
Query parameters (5):
  - customer — Customer URL
  - customer_keyword — Customer keyword (name, abbreviation or native name)
  - customer_uuid — Customer UUID
  - field
  - o — Ordering

### marketplace_service_providers_count
HEAD /api/marketplace-service-providers/
Summary: List service providers
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - customer — Customer URL
  - customer_keyword — Customer keyword (name, abbreviation or native name)
  - customer_uuid — Customer UUID
  - o — Ordering

### marketplace_service_providers_create
POST /api/marketplace-service-providers/
Summary: Create a service provider
Description: Creates a new service provider profile for a customer.
Request body: yes

### service_provider_checklists_summary
GET /api/marketplace-service-providers/{service_provider_uuid}/compliance/checklists_summary/
Summary: Get summary of compliance checklists
Description: Returns a summary of all compliance checklists used by this service provider with usage counts.
Path parameters:
  - service_provider_uuid

### marketplace_service_providers_compliance_checklists_summary_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/compliance/checklists_summary/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid

### service_provider_compliance_overview
GET /api/marketplace-service-providers/{service_provider_uuid}/compliance/compliance_overview/
Summary: Get compliance overview for a service provider
Description: Returns compliance overview statistics for all offerings managed by this service provider.
Path parameters:
  - service_provider_uuid

### marketplace_service_providers_compliance_compliance_overview_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/compliance/compliance_overview/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid

### service_provider_offering_users_compliance
GET /api/marketplace-service-providers/{service_provider_uuid}/compliance/offering_users/
Summary: List offering users' compliance status
Description: Returns a list of offering users with their compliance status for this service provider. Can be filtered by offering and compliance status.
Path parameters:
  - service_provider_uuid
Query parameters (2):
  - compliance_status — Filter by compliance status: completed, pending, no_checklist.
  - offering_uuid — Filter by offering UUID.

### marketplace_service_providers_compliance_offering_users_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/compliance/offering_users/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid

### marketplace_service_providers_course_accounts_list
GET /api/marketplace-service-providers/{service_provider_uuid}/course_accounts/
Summary: List course project accounts for a service provider
Description: Returns a paginated list of course project accounts that have access to resources managed by the provider.

        This includes:
        - Projects with active resources of the service provider.
        - Course accounts with non-blank users.
Path parameters:
  - service_provider_uuid
Query parameters (9):
  - email — Email contains
  - o — Ordering
  - project_end_date_after — Project end date range
  - project_end_date_before — Project end date range
  - project_start_date_after — Project start date range
  - project_start_date_before — Project start date range
  - project_uuid — Project UUID
  - state — Course account state
  - username — Username

### marketplace_service_providers_course_accounts_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/course_accounts/
Summary: List course project accounts for a service provider
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid
Query parameters (9):
  - email — Email contains
  - o — Ordering
  - project_end_date_after — Project end date range
  - project_end_date_before — Project end date range
  - project_start_date_after — Project start date range
  - project_start_date_before — Project start date range
  - project_uuid — Project UUID
  - state — Course account state
  - username — Username

### marketplace_service_providers_customer_projects_list
GET /api/marketplace-service-providers/{service_provider_uuid}/customer_projects/
Summary: List customer projects of a service provider
Description: Returns a paginated list of projects belonging to a specific customer that have consumed resources from the specified service provider.
Path parameters:
  - service_provider_uuid
Query parameters (28):
  - affiliation_name — Affiliation name
  - affiliation_uuid — Affiliation UUID
  - backend_id
  - can_admin — Return a list of projects where current user is admin.
  - can_manage — Return a list of projects where current user is manager or a customer owner.
  - conceal_finished_projects — Conceal finished projects
  - created — Created after
  - created_before — Created before
  - current_user_has_role — Multiple values may be separated by commas.
  - customer — Multiple values may be separated by commas.
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - description — Description
  - field
  - has_affiliation — Filter projects that have an affiliation.
  - is_removed — Is removed
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - project_customer_uuid (required) — UUID of the customer to filter projects by.
  - query — Filter by name, slug, UUID, backend ID or resource effective ID
  - science_domain_uuid — Science domain UUID
  - science_sub_domain_uuid — Science sub-domain UUID
  - slug — Slug
  - user_uuid_with_active_role — Filter projects where the given user has a role.

### marketplace_service_providers_customer_projects_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/customer_projects/
Summary: List customer projects of a service provider
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid
Query parameters (27):
  - affiliation_name — Affiliation name
  - affiliation_uuid — Affiliation UUID
  - backend_id
  - can_admin — Return a list of projects where current user is admin.
  - can_manage — Return a list of projects where current user is manager or a customer owner.
  - conceal_finished_projects — Conceal finished projects
  - created — Created after
  - created_before — Created before
  - current_user_has_role — Multiple values may be separated by commas.
  - customer — Multiple values may be separated by commas.
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - description — Description
  - has_affiliation — Filter projects that have an affiliation.
  - is_removed — Is removed
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - project_customer_uuid (required) — UUID of the customer to filter projects by.
  - query — Filter by name, slug, UUID, backend ID or resource effective ID
  - science_domain_uuid — Science domain UUID
  - science_sub_domain_uuid — Science sub-domain UUID
  - slug — Slug
  - user_uuid_with_active_role — Filter projects where the given user has a role.

### marketplace_service_providers_customers_list
GET /api/marketplace-service-providers/{service_provider_uuid}/customers/
Summary: List customers of a service provider
Description: Returns a paginated list of customers who have consumed resources from the specified service provider.
Path parameters:
  - service_provider_uuid
Query parameters (17):
  - abbreviation — Abbreviation
  - agreement_number
  - archived
  - backend_id
  - contact_details — Contact details
  - current_user_has_project_create_permission — Return a list of customers where current user has project create permission.
  - current_user_has_role — Multiple values may be separated by commas.
  - field
  - name — Name
  - name_exact — Name (exact)
  - native_name — Native name
  - organization_group_name — Organization group name
  - organization_group_uuid — Organization group UUID
  - owned_by_current_user — Return a list of customers where current user is owner.
  - query — Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
  - registration_code
  - slug — Slug

### marketplace_service_providers_customers_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/customers/
Summary: List customers of a service provider
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid
Query parameters (16):
  - abbreviation — Abbreviation
  - agreement_number
  - archived
  - backend_id
  - contact_details — Contact details
  - current_user_has_project_create_permission — Return a list of customers where current user has project create permission.
  - current_user_has_role — Multiple values may be separated by commas.
  - name — Name
  - name_exact — Name (exact)
  - native_name — Native name
  - organization_group_name — Organization group name
  - organization_group_uuid — Organization group UUID
  - owned_by_current_user — Return a list of customers where current user is owner.
  - query — Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
  - registration_code
  - slug — Slug

### marketplace_service_providers_keys_list
GET /api/marketplace-service-providers/{service_provider_uuid}/keys/
Summary: List SSH keys of a service provider
Description: Returns a paginated list of SSH public keys for all users who have consumed resources from the specified service provider.
Path parameters:
  - service_provider_uuid
Query parameters (13):
  - created — Created after
  - created_before — Created before
  - field
  - fingerprint_md5
  - fingerprint_sha256
  - fingerprint_sha512
  - is_shared
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - user_uuid — User UUID

### marketplace_service_providers_keys_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/keys/
Summary: List SSH keys of a service provider
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid
Query parameters (12):
  - created — Created after
  - created_before — Created before
  - fingerprint_md5
  - fingerprint_sha256
  - fingerprint_sha512
  - is_shared
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - user_uuid — User UUID

### marketplace_service_providers_offerings_list
GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/
Summary: List offerings of a service provider
Description: Returns a paginated list of all billable, shared offerings provided by the specified service provider.
Path parameters:
  - service_provider_uuid
Query parameters (41):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - field
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_service_providers_offerings_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/offerings/
Summary: List offerings of a service provider
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid
Query parameters (40):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_service_providers_offerings_types_list
GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/types/
Summary: List distinct offering types for a service provider
Path parameters:
  - service_provider_uuid
Query parameters (40):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_service_providers_offerings_types_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/offerings/types/
Summary: List distinct offering types for a service provider
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid
Query parameters (40):
  - accessible_via_calls — Accessible via calls
  - allowed_customer_uuid — Allowed customer UUID
  - attributes — Offering attributes (JSON)
  - billable — Billable
  - can_create_offering_user
  - category_group_uuid — Category group UUID
  - category_uuid — Category UUID
  - created — Created after
  - created_before — Created before
  - customer — Customer URL
  - customer_uuid — Customer UUID
  - description — Description contains
  - has_active_terms_of_service — Has Active Terms of Service
  - has_terms_of_service — Has Terms of Service
  - keyword — Keyword
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - offering_group_uuid — Offering group UUID
  - organization_group_uuid — Organization group UUID
  - parent_uuid — Parent offering UUID
  - project_uuid — Project UUID
  - query — Search by offering name, slug or description
  - resource_customer_uuid — Resource customer UUID
  - resource_project_uuid — Resource project UUID
  - scope_uuid — Scope UUID
  - service_manager_uuid — Service manager UUID
  - shared — Shared
  - slug — Slug
  - state — Offering state
  - tag — Tag UUID (OR logic)
  - tag_name — Tag name (OR logic)
  - tag_names_and — Tag names with AND logic (comma-separated)
  - tags_and — Tag UUIDs with AND logic (comma-separated)
  - type — Offering type
  - user_has_consent — User Has Consent
  - user_has_offering_user — User Has Offering User
  - uuid_list — Comma-separated offering UUIDs

### marketplace_service_providers_project_permissions_list
GET /api/marketplace-service-providers/{service_provider_uuid}/project_permissions/
Summary: List project permissions of a service provider
Description: Returns a paginated list of project permissions for all projects that have consumed resources from the specified service provider.
Path parameters:
  - service_provider_uuid
Query parameters (19):
  - created — Created after
  - created_before — Created before
  - expiration_time
  - field
  - full_name — User full name contains
  - is_active
  - modified — Modified after
  - modified_before — Modified before
  - native_name
  - o — Ordering
  - role_name — Role name contains
  - role_uuid — Role UUID
  - scope_name — Scope name
  - scope_type — Scope type
  - scope_uuid — Scope UUID
  - user
  - user_slug — User slug contains
  - user_url
  - username

### marketplace_service_providers_project_permissions_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/project_permissions/
Summary: List project permissions of a service provider
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid
Query parameters (18):
  - created — Created after
  - created_before — Created before
  - expiration_time
  - full_name — User full name contains
  - is_active
  - modified — Modified after
  - modified_before — Modified before
  - native_name
  - o — Ordering
  - role_name — Role name contains
  - role_uuid — Role UUID
  - scope_name — Scope name
  - scope_type — Scope type
  - scope_uuid — Scope UUID
  - user
  - user_slug — User slug contains
  - user_url
  - username

### marketplace_service_providers_project_service_accounts_list
GET /api/marketplace-service-providers/{service_provider_uuid}/project_service_accounts/
Summary: List project service accounts for a service provider
Description: Returns a paginated list of project service accounts that have access to resources managed by the provider.

        This includes:
        - Projects with active resources of the service provider.
        - Service accounts with non-blank usernames.
Path parameters:
  - service_provider_uuid
Query parameters (5):
  - email — Email contains
  - project — Project URL
  - project_uuid — Project UUID
  - state — Service account state
  - username — Username

### marketplace_service_providers_project_service_accounts_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/project_service_accounts/
Summary: List project service accounts for a service provider
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid
Query parameters (5):
  - email — Email contains
  - project — Project URL
  - project_uuid — Project UUID
  - state — Service account state
  - username — Username

### marketplace_service_providers_projects_list
GET /api/marketplace-service-providers/{service_provider_uuid}/projects/
Summary: List projects of a service provider
Description: Returns a paginated list of all projects that have consumed resources from the specified service provider.
Path parameters:
  - service_provider_uuid
Query parameters (27):
  - affiliation_name — Affiliation name
  - affiliation_uuid — Affiliation UUID
  - backend_id
  - can_admin — Return a list of projects where current user is admin.
  - can_manage — Return a list of projects where current user is manager or a customer owner.
  - conceal_finished_projects — Conceal finished projects
  - created — Created after
  - created_before — Created before
  - current_user_has_role — Multiple values may be separated by commas.
  - customer — Multiple values may be separated by commas.
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - description — Description
  - field
  - has_affiliation — Filter projects that have an affiliation.
  - is_removed — Is removed
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - query — Filter by name, slug, UUID, backend ID or resource effective ID
  - science_domain_uuid — Science domain UUID
  - science_sub_domain_uuid — Science sub-domain UUID
  - slug — Slug
  - user_uuid_with_active_role — Filter projects where the given user has a role.

### marketplace_service_providers_projects_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/projects/
Summary: List projects of a service provider
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid
Query parameters (26):
  - affiliation_name — Affiliation name
  - affiliation_uuid — Affiliation UUID
  - backend_id
  - can_admin — Return a list of projects where current user is admin.
  - can_manage — Return a list of projects where current user is manager or a customer owner.
  - conceal_finished_projects — Conceal finished projects
  - created — Created after
  - created_before — Created before
  - current_user_has_role — Multiple values may be separated by commas.
  - customer — Multiple values may be separated by commas.
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - description — Description
  - has_affiliation — Filter projects that have an affiliation.
  - is_removed — Is removed
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - query — Filter by name, slug, UUID, backend ID or resource effective ID
  - science_domain_uuid — Science domain UUID
  - science_sub_domain_uuid — Science sub-domain UUID
  - slug — Slug
  - user_uuid_with_active_role — Filter projects where the given user has a role.

### marketplace_service_providers_user_customers_list
GET /api/marketplace-service-providers/{service_provider_uuid}/user_customers/
Summary: List customers of a specific user within a service provider's scope
Description: Returns a paginated list of customers that a specified user has access to within the scope of a service provider.

        This includes:
        - Customers where the user has direct permissions.
        - Customers with projects where the user has project roles.
        - Customers related to t...
Path parameters:
  - service_provider_uuid
Query parameters (18):
  - abbreviation — Abbreviation
  - agreement_number
  - archived
  - backend_id
  - contact_details — Contact details
  - current_user_has_project_create_permission — Return a list of customers where current user has project create permission.
  - current_user_has_role — Multiple values may be separated by commas.
  - field
  - name — Name
  - name_exact — Name (exact)
  - native_name — Native name
  - organization_group_name — Organization group name
  - organization_group_uuid — Organization group UUID
  - owned_by_current_user — Return a list of customers where current user is owner.
  - query — Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
  - registration_code
  - slug — Slug
  - user_uuid (required) — UUID of the user to get related customers for.

### marketplace_service_providers_user_customers_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/user_customers/
Summary: List customers of a specific user within a service provider's scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid
Query parameters (17):
  - abbreviation — Abbreviation
  - agreement_number
  - archived
  - backend_id
  - contact_details — Contact details
  - current_user_has_project_create_permission — Return a list of customers where current user has project create permission.
  - current_user_has_role — Multiple values may be separated by commas.
  - name — Name
  - name_exact — Name (exact)
  - native_name — Native name
  - organization_group_name — Organization group name
  - organization_group_uuid — Organization group UUID
  - owned_by_current_user — Return a list of customers where current user is owner.
  - query — Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
  - registration_code
  - slug — Slug
  - user_uuid (required) — UUID of the user to get related customers for.

### marketplace_service_providers_users_list
GET /api/marketplace-service-providers/{service_provider_uuid}/users/
Summary: List users of a service provider
Description: Returns a paginated list of all users who have consumed resources from the specified service provider.
Path parameters:
  - service_provider_uuid
Query parameters (25):
  - agreement_date — Agreement date after
  - civil_number
  - customer_uuid — Customer UUID
  - date_joined — Date joined after
  - description
  - email — Email
  - field
  - full_name — Full name
  - is_active — Is active
  - is_staff — Is staff
  - is_support — Is support
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering
  - organization — Organization
  - organization_roles — Organization roles
  - phone_number
  - project_roles — Project roles
  - project_uuid — Project UUID
  - query — Filter by first name, last name, civil number, username or email
  - registration_method
  - user_keyword — User keyword
  - username — Username (exact)
  - username_list — Comma-separated usernames

### marketplace_service_providers_users_count
HEAD /api/marketplace-service-providers/{service_provider_uuid}/users/
Summary: List users of a service provider
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - service_provider_uuid
Query parameters (24):
  - agreement_date — Agreement date after
  - civil_number
  - customer_uuid — Customer UUID
  - date_joined — Date joined after
  - description
  - email — Email
  - full_name — Full name
  - is_active — Is active
  - is_staff — Is staff
  - is_support — Is support
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering
  - organization — Organization
  - organization_roles — Organization roles
  - phone_number
  - project_roles — Project roles
  - project_uuid — Project UUID
  - query — Filter by first name, last name, civil number, username or email
  - registration_method
  - user_keyword — User keyword
  - username — Username (exact)
  - username_list — Comma-separated usernames

### marketplace_service_providers_retrieve
GET /api/marketplace-service-providers/{uuid}/
Summary: Retrieve a service provider
Description: Returns details of a specific service provider.
Path parameters:
  - uuid
Query parameters (1):
  - field

### marketplace_service_providers_update
PUT /api/marketplace-service-providers/{uuid}/
Summary: Update a service provider
Description: Updates an existing service provider profile.
Path parameters:
  - uuid
Request body: yes

### marketplace_service_providers_partial_update
PATCH /api/marketplace-service-providers/{uuid}/
Summary: Partially update a service provider
Description: Partially updates an existing service provider profile.
Path parameters:
  - uuid
Request body: yes

### marketplace_service_providers_destroy
DELETE /api/marketplace-service-providers/{uuid}/
Summary: Delete a service provider
Description: Deletes a service provider profile. Only possible if there are no active offerings.
Path parameters:
  - uuid

### marketplace_service_providers_add_user
POST /api/marketplace-service-providers/{uuid}/add_user/
Summary: Grant a role to a user
Description: Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
Path parameters:
  - uuid
Request body: yes

### service_provider_api_secret_code_retrieve
GET /api/marketplace-service-providers/{uuid}/api_secret_code/
Summary: Get service provider API secret code
Description: Returns the API secret code for a service provider. Requires service provider owner permission.
Path parameters:
  - uuid

### service_provider_api_secret_code_generate
POST /api/marketplace-service-providers/{uuid}/api_secret_code/
Summary: Generate new service provider API secret code
Description: Generates a new API secret code for a service provider, invalidating the old one. Requires service provider owner permission.
Path parameters:
  - uuid

### marketplace_service_providers_delete_user
POST /api/marketplace-service-providers/{uuid}/delete_user/
Summary: Revoke a role from a user
Description: Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
Path parameters:
  - uuid
Request body: yes

### marketplace_service_providers_generate_site_agent_config
POST /api/marketplace-service-providers/{uuid}/generate_site_agent_config/
Summary: Generate site agent configuration
Description: Generates a YAML configuration file for waldur-site-agent based on selected SLURM offerings. The configuration includes offering details, components, backend settings, and optionally SLURM periodic usage policy settings. Secrets are shown as placeholders that need to be filled in.
Path parameters:
  - uuid
Request body: yes

### marketplace_service_providers_list_users_list
GET /api/marketplace-service-providers/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### marketplace_service_providers_list_users_count
HEAD /api/marketplace-service-providers/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### marketplace_service_providers_revenue_list
GET /api/marketplace-service-providers/{uuid}/revenue/
Summary: Get service provider revenue
Description: Returns monthly revenue data for the last year for the service provider.
Path parameters:
  - uuid

### marketplace_service_providers_robot_account_customers_list
GET /api/marketplace-service-providers/{uuid}/robot_account_customers/
Summary: List customers with robot accounts
Description: Returns a paginated list of customers who have robot accounts for resources managed by this service provider.
Path parameters:
  - uuid
Query parameters (1):
  - customer_name — Filter by customer name (case-insensitive partial match).

### marketplace_service_providers_robot_account_projects_list
GET /api/marketplace-service-providers/{uuid}/robot_account_projects/
Summary: List projects with robot accounts
Description: Returns a paginated list of projects which have robot accounts for resources managed by this service provider.
Path parameters:
  - uuid
Query parameters (1):
  - project_name — Filter by project name (case-insensitive partial match).

### marketplace_service_providers_set_offerings_username
POST /api/marketplace-service-providers/{uuid}/set_offerings_username/
Summary: Set offering username for a user
Description: Sets or updates the offering-specific username for a user across all offerings managed by the service provider that the user has access to.
Path parameters:
  - uuid
Request body: yes

### marketplace_service_providers_stat_retrieve
GET /api/marketplace-service-providers/{uuid}/stat/
Summary: Get service provider statistics
Description: Returns various statistics for the service provider, such as number of active campaigns, customers, and resources.
Path parameters:
  - uuid

### marketplace_service_providers_update_user
POST /api/marketplace-service-providers/{uuid}/update_user/
Summary: Update a user's role expiration
Description: Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-site-agent-connection-stats  (module: waldur_api_client.api.marketplace_site_agent_connection_stats)
============================================================

### marketplace_site_agent_connection_stats_retrieve
GET /api/marketplace-site-agent-connection-stats/
Summary: Get agent connection statistics
Description: Returns connection status for all registered agents.

For each agent identity, provides:
- Agent metadata (name, version, offering)
- Services and their states
- Event subscriptions with RabbitMQ connection status
- RabbitMQ queues associated with the agent's offering

The RMQ connection data inc...

============================================================
## marketplace-site-agent-identities  (module: waldur_api_client.api.marketplace_site_agent_identities)
============================================================

### marketplace_site_agent_identities_list
GET /api/marketplace-site-agent-identities/
Query parameters (5):
  - last_restarted — Last restarted after
  - name
  - offering_uuid
  - orphaned — Has no services
  - version

### marketplace_site_agent_identities_count
HEAD /api/marketplace-site-agent-identities/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - last_restarted — Last restarted after
  - name
  - offering_uuid
  - orphaned — Has no services
  - version

### marketplace_site_agent_identities_create
POST /api/marketplace-site-agent-identities/
Request body: yes

### marketplace_site_agent_identities_cleanup_orphaned
POST /api/marketplace-site-agent-identities/cleanup_orphaned/
Summary: Remove agent identities that have no active services
Description: Remove agent identities that have no active services. Staff only.
Request body: yes

### marketplace_site_agent_identities_retrieve
GET /api/marketplace-site-agent-identities/{uuid}/
Path parameters:
  - uuid

### marketplace_site_agent_identities_update
PUT /api/marketplace-site-agent-identities/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_site_agent_identities_destroy
DELETE /api/marketplace-site-agent-identities/{uuid}/
Path parameters:
  - uuid

### marketplace_site_agent_identities_register_event_subscription
POST /api/marketplace-site-agent-identities/{uuid}/register_event_subscription/
Summary: Register an event subscription for the specified agent identity and observable object type
Description: Register an event subscription for the specified agent identity and observable object type. Returns existing subscription if already exists.
Path parameters:
  - uuid
Request body: yes

### marketplace_site_agent_identities_register_service
POST /api/marketplace-site-agent-identities/{uuid}/register_service/
Summary: Register a new processor or get the existing one for the agent service
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-site-agent-logs  (module: waldur_api_client.api.marketplace_site_agent_logs)
============================================================

### marketplace_site_agent_logs_list
GET /api/marketplace-site-agent-logs/
Query parameters (5):
  - agent_identity_uuid
  - level
  - offering_uuid
  - timestamp_from
  - timestamp_to

### marketplace_site_agent_logs_count
HEAD /api/marketplace-site-agent-logs/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - agent_identity_uuid
  - level
  - offering_uuid
  - timestamp_from
  - timestamp_to

### marketplace_site_agent_logs_create
POST /api/marketplace-site-agent-logs/
Summary: Push site agent logs
Description: Receive a batch of log entries from a site agent. Send a list where each entry includes agent_identity_uuid.
Query parameters (5):
  - agent_identity_uuid
  - level
  - offering_uuid
  - timestamp_from
  - timestamp_to
Request body: yes

============================================================
## marketplace-site-agent-processors  (module: waldur_api_client.api.marketplace_site_agent_processors)
============================================================

### marketplace_site_agent_processors_list
GET /api/marketplace-site-agent-processors/
Query parameters (6):
  - backend_type
  - backend_version
  - last_run — Last run after
  - last_run_before — Last run before
  - service_uuid
  - stale — Last run more than 1 hour ago

### marketplace_site_agent_processors_count
HEAD /api/marketplace-site-agent-processors/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - backend_type
  - backend_version
  - last_run — Last run after
  - last_run_before — Last run before
  - service_uuid
  - stale — Last run more than 1 hour ago

### marketplace_site_agent_processors_retrieve
GET /api/marketplace-site-agent-processors/{uuid}/
Path parameters:
  - uuid

### marketplace_site_agent_processors_destroy
DELETE /api/marketplace-site-agent-processors/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-site-agent-services  (module: waldur_api_client.api.marketplace_site_agent_services)
============================================================

### marketplace_site_agent_services_list
GET /api/marketplace-site-agent-services/
Query parameters (6):
  - identity_uuid
  - mode
  - modified_after — Modified after
  - modified_before — Modified before
  - stale — Inactive for more than 24 hours
  - state

### marketplace_site_agent_services_count
HEAD /api/marketplace-site-agent-services/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - identity_uuid
  - mode
  - modified_after — Modified after
  - modified_before — Modified before
  - stale — Inactive for more than 24 hours
  - state

### marketplace_site_agent_services_cleanup_stale
POST /api/marketplace-site-agent-services/cleanup_stale/
Summary: Remove agent services that have been inactive for a specified time
Description: Remove agent services that have been inactive for a specified time. Staff only.
Request body: yes

### marketplace_site_agent_services_retrieve
GET /api/marketplace-site-agent-services/{uuid}/
Path parameters:
  - uuid

### marketplace_site_agent_services_destroy
DELETE /api/marketplace-site-agent-services/{uuid}/
Path parameters:
  - uuid

### marketplace_site_agent_services_register_processor
POST /api/marketplace-site-agent-services/{uuid}/register_processor/
Summary: Register a new processor for the agent service
Path parameters:
  - uuid
Request body: yes

### marketplace_site_agent_services_set_statistics
POST /api/marketplace-site-agent-services/{uuid}/set_statistics/
Summary: Update statistics for the agent service
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-site-agent-stats  (module: waldur_api_client.api.marketplace_site_agent_stats)
============================================================

### marketplace_site_agent_stats_retrieve
GET /api/marketplace-site-agent-stats/
Summary: Get aggregated statistics about agent identities, services, and processors
Description: Get aggregated statistics about agent identities, services, and processors. Support users only.

============================================================
## marketplace-site-agent-task-stats  (module: waldur_api_client.api.marketplace_site_agent_task_stats)
============================================================

### marketplace_site_agent_task_stats_retrieve
GET /api/marketplace-site-agent-task-stats/
Summary: Get Celery task status for agent-related tasks
Description: Get Celery task status for agent-related tasks. Support users only.

============================================================
## marketplace-slurm-periodic-usage-policies  (module: waldur_api_client.api.marketplace_slurm_periodic_usage_policies)
============================================================

### marketplace_slurm_periodic_usage_policies_list
GET /api/marketplace-slurm-periodic-usage-policies/
Query parameters (2):
  - scope
  - scope_uuid

### marketplace_slurm_periodic_usage_policies_count
HEAD /api/marketplace-slurm-periodic-usage-policies/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - scope
  - scope_uuid

### marketplace_slurm_periodic_usage_policies_create
POST /api/marketplace-slurm-periodic-usage-policies/
Request body: yes

### marketplace_slurm_periodic_usage_policies_actions_retrieve
GET /api/marketplace-slurm-periodic-usage-policies/actions/

### marketplace_slurm_periodic_usage_policies_actions_count
HEAD /api/marketplace-slurm-periodic-usage-policies/actions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_slurm_periodic_usage_policies_preview_impact
POST /api/marketplace-slurm-periodic-usage-policies/preview_impact/
Summary: Preview policy impact without saving
Description: Preview policy impact without saving. Returns threshold calculations, carryover projections, and QoS trigger points.
Request body: yes

### marketplace_slurm_periodic_usage_policies_retrieve
GET /api/marketplace-slurm-periodic-usage-policies/{uuid}/
Path parameters:
  - uuid

### marketplace_slurm_periodic_usage_policies_update
PUT /api/marketplace-slurm-periodic-usage-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_slurm_periodic_usage_policies_partial_update
PATCH /api/marketplace-slurm-periodic-usage-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_slurm_periodic_usage_policies_destroy
DELETE /api/marketplace-slurm-periodic-usage-policies/{uuid}/
Path parameters:
  - uuid

### marketplace_slurm_periodic_usage_policies_command_history_list
GET /api/marketplace-slurm-periodic-usage-policies/{uuid}/command-history/
Summary: List command history for this policy
Description: List command history for this policy.
Path parameters:
  - uuid
Query parameters (2):
  - scope
  - scope_uuid

### marketplace_slurm_periodic_usage_policies_dry_run
POST /api/marketplace-slurm-periodic-usage-policies/{uuid}/dry-run/
Summary: Staff-only
Description: Staff-only. Dry-run evaluation: calculates usage percentages and shows what actions would be triggered, without applying any changes.
Path parameters:
  - uuid
Request body: yes

### marketplace_slurm_periodic_usage_policies_evaluate
POST /api/marketplace-slurm-periodic-usage-policies/{uuid}/evaluate/
Summary: Staff-only
Description: Staff-only. Run synchronous policy evaluation: calculates usage, applies actions (pause/downscale/notify), and creates evaluation logs.
Path parameters:
  - uuid
Request body: yes

### marketplace_slurm_periodic_usage_policies_evaluation_logs_list
GET /api/marketplace-slurm-periodic-usage-policies/{uuid}/evaluation-logs/
Summary: List evaluation logs for this policy
Description: List evaluation logs for this policy.
Path parameters:
  - uuid
Query parameters (2):
  - scope
  - scope_uuid

### marketplace_slurm_periodic_usage_policies_force_period_reset
POST /api/marketplace-slurm-periodic-usage-policies/{uuid}/force-period-reset/
Summary: Staff-only
Description: Staff-only. Force-trigger period reset: re-evaluates paused/downscaled resources whose usage in the current period is below thresholds. Useful after a Celery beat outage or to immediately unblock resources.
Path parameters:
  - uuid
Request body: yes

### marketplace_slurm_periodic_usage_policies_report_command_result
POST /api/marketplace-slurm-periodic-usage-policies/{uuid}/report-command-result/
Summary: Report command execution result from site agent
Description: Report command execution result from site agent.
Path parameters:
  - uuid
Request body: yes

============================================================
## marketplace-software-catalogs  (module: waldur_api_client.api.marketplace_software_catalogs)
============================================================

### marketplace_software_catalogs_list
GET /api/marketplace-software-catalogs/
Summary: List software catalogs
Description: Returns a paginated list of available software catalogs, such as EESSI or Spack.
Query parameters (6):
  - auto_update_enabled — Filter catalogs by auto-update status
  - catalog_type — Filter by catalog type (binary_runtime, source_package, package_manager)
  - description — Filter catalogs by description (case-insensitive partial match)
  - name
  - o — Ordering
  - version

### marketplace_software_catalogs_count
HEAD /api/marketplace-software-catalogs/
Summary: List software catalogs
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - auto_update_enabled — Filter catalogs by auto-update status
  - catalog_type — Filter by catalog type (binary_runtime, source_package, package_manager)
  - description — Filter catalogs by description (case-insensitive partial match)
  - name
  - o — Ordering
  - version

### marketplace_software_catalogs_create
POST /api/marketplace-software-catalogs/
Summary: Create a software catalog
Description: Creates a new software catalog. Requires staff permissions.
Request body: yes

### marketplace_software_catalogs_discover_list
GET /api/marketplace-software-catalogs/discover/
Summary: Discover available software catalog versions
Description: Queries upstream sources (EESSI, Spack) for available catalog versions without creating anything. Returns detected versions and whether an update is available compared to existing database records.
Query parameters (6):
  - auto_update_enabled — Filter catalogs by auto-update status
  - catalog_type — Filter by catalog type (binary_runtime, source_package, package_manager)
  - description — Filter catalogs by description (case-insensitive partial match)
  - name
  - o — Ordering
  - version

### marketplace_software_catalogs_discover_count
HEAD /api/marketplace-software-catalogs/discover/
Summary: Discover available software catalog versions
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - auto_update_enabled — Filter catalogs by auto-update status
  - catalog_type — Filter by catalog type (binary_runtime, source_package, package_manager)
  - description — Filter catalogs by description (case-insensitive partial match)
  - name
  - o — Ordering
  - version

### marketplace_software_catalogs_import_catalog
POST /api/marketplace-software-catalogs/import_catalog/
Summary: Import a new software catalog
Description: Creates a new catalog record and triggers async data loading via Celery. Returns 202 Accepted immediately. Staff only.
Request body: yes

### marketplace_software_catalogs_retrieve
GET /api/marketplace-software-catalogs/{uuid}/
Summary: Retrieve a software catalog
Description: Returns the details of a specific software catalog, including its name, version, and the number of packages it contains.
Path parameters:
  - uuid

### marketplace_software_catalogs_update
PUT /api/marketplace-software-catalogs/{uuid}/
Summary: Update a software catalog
Description: Updates an existing software catalog. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_software_catalogs_partial_update
PATCH /api/marketplace-software-catalogs/{uuid}/
Summary: Partially update a software catalog
Description: Partially updates an existing software catalog. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_software_catalogs_destroy
DELETE /api/marketplace-software-catalogs/{uuid}/
Summary: Delete a software catalog
Description: Deletes a software catalog. Requires staff permissions.
Path parameters:
  - uuid

### marketplace_software_catalogs_update_catalog
POST /api/marketplace-software-catalogs/{uuid}/update_catalog/
Summary: Trigger async update for an existing catalog
Description: Triggers a Celery task to update the given catalog from its upstream source. Returns 202 Accepted immediately. Staff only.
Path parameters:
  - uuid

============================================================
## marketplace-software-packages  (module: waldur_api_client.api.marketplace_software_packages)
============================================================

### marketplace_software_packages_list
GET /api/marketplace-software-packages/
Summary: List software packages
Description: Returns a paginated list of software packages available in the catalogs. Can be filtered by catalog, offering, or various package attributes.
Query parameters (23):
  - catalog_name — Filter packages by catalog name (case-insensitive partial match)
  - catalog_type — Filter packages by catalog type (binary_runtime, source_package, package_manager)
  - catalog_uuid — Filter packages from a specific software catalog
  - catalog_version — Filter packages by catalog version (case-insensitive partial match)
  - category — Filter packages by category (e.g., bio, hpc, chemistry)
  - cpu_family — Filter packages available for specific CPU family (e.g., x86_64, aarch64)
  - cpu_microarchitecture — Filter packages available for specific CPU microarchitecture (e.g., generic, zen2, haswell)
  - description — Filter packages by description (case-insensitive partial match)
  - extension_name — Filter packages having extensions with a specific name
  - extension_type — Filter packages having extensions of a specific type (e.g., 'python')
  - gpu_arch — Filter packages by GPU architecture (e.g., nvidia/cc90)
  - has_gpu — Filter packages that have GPU-enabled builds
  - has_version — Filter packages that have a specific version
  - is_extension — Filter packages that are extensions of other packages
  - license — Filter packages by license (e.g., GPL-3.0, MIT)
  - name — Filter packages by name (case-insensitive partial match)
  - name_exact — Filter packages by exact name (case-insensitive)
  - o — Ordering
  - offering_uuid — Filter packages available for a specific offering
  - parent_software_uuid — Filter extension packages belonging to a specific parent package
  - query — Query packages by name, description, or version (case-insensitive partial match)
  - toolchain_families_compatibility — Filter packages compatible with a specific toolchain family (e.g., foss_2022b)
  - toolchain_name — Filter packages by toolchain name (e.g., foss, gfbf)

### marketplace_software_packages_count
HEAD /api/marketplace-software-packages/
Summary: List software packages
Description: Get number of items in the collection matching the request parameters.
Query parameters (23):
  - catalog_name — Filter packages by catalog name (case-insensitive partial match)
  - catalog_type — Filter packages by catalog type (binary_runtime, source_package, package_manager)
  - catalog_uuid — Filter packages from a specific software catalog
  - catalog_version — Filter packages by catalog version (case-insensitive partial match)
  - category — Filter packages by category (e.g., bio, hpc, chemistry)
  - cpu_family — Filter packages available for specific CPU family (e.g., x86_64, aarch64)
  - cpu_microarchitecture — Filter packages available for specific CPU microarchitecture (e.g., generic, zen2, haswell)
  - description — Filter packages by description (case-insensitive partial match)
  - extension_name — Filter packages having extensions with a specific name
  - extension_type — Filter packages having extensions of a specific type (e.g., 'python')
  - gpu_arch — Filter packages by GPU architecture (e.g., nvidia/cc90)
  - has_gpu — Filter packages that have GPU-enabled builds
  - has_version — Filter packages that have a specific version
  - is_extension — Filter packages that are extensions of other packages
  - license — Filter packages by license (e.g., GPL-3.0, MIT)
  - name — Filter packages by name (case-insensitive partial match)
  - name_exact — Filter packages by exact name (case-insensitive)
  - o — Ordering
  - offering_uuid — Filter packages available for a specific offering
  - parent_software_uuid — Filter extension packages belonging to a specific parent package
  - query — Query packages by name, description, or version (case-insensitive partial match)
  - toolchain_families_compatibility — Filter packages compatible with a specific toolchain family (e.g., foss_2022b)
  - toolchain_name — Filter packages by toolchain name (e.g., foss, gfbf)

### marketplace_software_packages_create
POST /api/marketplace-software-packages/
Summary: Create a software package
Description: Creates a new software package within a catalog. Requires staff permissions.
Request body: yes

### marketplace_software_packages_retrieve
GET /api/marketplace-software-packages/{uuid}/
Summary: Retrieve a software package
Description: Returns the details of a specific software package, including its description, homepage, and available versions.
Path parameters:
  - uuid

### marketplace_software_packages_update
PUT /api/marketplace-software-packages/{uuid}/
Summary: Update a software package
Description: Updates an existing software package. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_software_packages_partial_update
PATCH /api/marketplace-software-packages/{uuid}/
Summary: Partially update a software package
Description: Partially updates an existing software package. Requires staff permissions.
Path parameters:
  - uuid
Request body: yes

### marketplace_software_packages_destroy
DELETE /api/marketplace-software-packages/{uuid}/
Summary: Delete a software package
Description: Deletes a software package. Requires staff permissions.
Path parameters:
  - uuid

============================================================
## marketplace-software-targets  (module: waldur_api_client.api.marketplace_software_targets)
============================================================

### marketplace_software_targets_list
GET /api/marketplace-software-targets/
Summary: List software targets
Description: Returns a paginated list of software targets, which represent specific builds of a software version for a given CPU architecture.
Query parameters (13):
  - catalog_uuid
  - cpu_family
  - cpu_microarchitecture
  - gpu_arch — Filter targets by GPU architecture (e.g., nvidia/cc90)
  - has_gpu — Filter targets that have GPU architectures
  - o — Ordering
  - offering_uuid
  - package_uuid
  - path — Filter targets by location/path (case-insensitive partial match)
  - target_name — Filter targets by name (e.g., x86_64, aarch64)
  - target_subtype — Filter targets by subtype (e.g., microarchitecture, distribution)
  - target_type — Filter targets by type (e.g., architecture, platform, variant)
  - version_uuid

### marketplace_software_targets_count
HEAD /api/marketplace-software-targets/
Summary: List software targets
Description: Get number of items in the collection matching the request parameters.
Query parameters (13):
  - catalog_uuid
  - cpu_family
  - cpu_microarchitecture
  - gpu_arch — Filter targets by GPU architecture (e.g., nvidia/cc90)
  - has_gpu — Filter targets that have GPU architectures
  - o — Ordering
  - offering_uuid
  - package_uuid
  - path — Filter targets by location/path (case-insensitive partial match)
  - target_name — Filter targets by name (e.g., x86_64, aarch64)
  - target_subtype — Filter targets by subtype (e.g., microarchitecture, distribution)
  - target_type — Filter targets by type (e.g., architecture, platform, variant)
  - version_uuid

### marketplace_software_targets_create
POST /api/marketplace-software-targets/
Summary: Create a software target
Description: Creates a new target for a software version. Requires staff permissions.

### marketplace_software_targets_retrieve
GET /api/marketplace-software-targets/{uuid}/
Summary: Retrieve a software target
Description: Returns the details of a specific software target, including its CPU family, microarchitecture, and path.
Path parameters:
  - uuid

### marketplace_software_targets_update
PUT /api/marketplace-software-targets/{uuid}/
Summary: Update a software target
Description: Updates an existing software target. Requires staff permissions.
Path parameters:
  - uuid

### marketplace_software_targets_partial_update
PATCH /api/marketplace-software-targets/{uuid}/
Summary: Partially update a software target
Description: Partially updates an existing software target. Requires staff permissions.
Path parameters:
  - uuid

### marketplace_software_targets_destroy
DELETE /api/marketplace-software-targets/{uuid}/
Summary: Delete a software target
Description: Deletes a software target. Requires staff permissions.
Path parameters:
  - uuid

============================================================
## marketplace-software-versions  (module: waldur_api_client.api.marketplace_software_versions)
============================================================

### marketplace_software_versions_list
GET /api/marketplace-software-versions/
Summary: List software versions
Description: Returns a paginated list of software versions. Can be filtered by package, catalog, offering, or CPU architecture.
Query parameters (17):
  - catalog_type — Filter versions by catalog type (binary_runtime, source_package, package_manager)
  - catalog_uuid
  - cpu_family
  - cpu_microarchitecture
  - gpu_arch — Filter versions by GPU architecture (e.g., nvidia/cc90)
  - has_gpu — Filter versions that have GPU-enabled builds
  - o — Ordering
  - offering_uuid
  - package_name
  - package_uuid
  - release_date_after — Filter versions by release date range (release_date_after, release_date_before)
  - release_date_before — Filter versions by release date range (release_date_after, release_date_before)
  - toolchain_families_compatibility — Filter versions compatible with a specific toolchain family (e.g., foss_2022b)
  - toolchain_name — Filter versions by toolchain name (e.g., foss, gfbf)
  - toolchain_version — Filter versions by toolchain version (e.g., 2023b)
  - version
  - version_exact — Filter versions by exact version string

### marketplace_software_versions_count
HEAD /api/marketplace-software-versions/
Summary: List software versions
Description: Get number of items in the collection matching the request parameters.
Query parameters (17):
  - catalog_type — Filter versions by catalog type (binary_runtime, source_package, package_manager)
  - catalog_uuid
  - cpu_family
  - cpu_microarchitecture
  - gpu_arch — Filter versions by GPU architecture (e.g., nvidia/cc90)
  - has_gpu — Filter versions that have GPU-enabled builds
  - o — Ordering
  - offering_uuid
  - package_name
  - package_uuid
  - release_date_after — Filter versions by release date range (release_date_after, release_date_before)
  - release_date_before — Filter versions by release date range (release_date_after, release_date_before)
  - toolchain_families_compatibility — Filter versions compatible with a specific toolchain family (e.g., foss_2022b)
  - toolchain_name — Filter versions by toolchain name (e.g., foss, gfbf)
  - toolchain_version — Filter versions by toolchain version (e.g., 2023b)
  - version
  - version_exact — Filter versions by exact version string

### marketplace_software_versions_create
POST /api/marketplace-software-versions/
Summary: Create a software version
Description: Creates a new version for a software package. Requires staff permissions.

### marketplace_software_versions_retrieve
GET /api/marketplace-software-versions/{uuid}/
Summary: Retrieve a software version
Description: Returns the details of a specific software version, including its release date and target count.
Path parameters:
  - uuid

### marketplace_software_versions_update
PUT /api/marketplace-software-versions/{uuid}/
Summary: Update a software version
Description: Updates an existing software version. Requires staff permissions.
Path parameters:
  - uuid

### marketplace_software_versions_partial_update
PATCH /api/marketplace-software-versions/{uuid}/
Summary: Partially update a software version
Description: Partially updates an existing software version. Requires staff permissions.
Path parameters:
  - uuid

### marketplace_software_versions_destroy
DELETE /api/marketplace-software-versions/{uuid}/
Summary: Delete a software version
Description: Deletes a software version. Requires staff permissions.
Path parameters:
  - uuid

============================================================
## marketplace-stats  (module: waldur_api_client.api.marketplace_stats)
============================================================

### marketplace_stats_aggregated_usage_trends_list
GET /api/marketplace-stats/aggregated_usage_trends/
Summary: Return aggregated usage trends per month
Description: Return aggregated usage trends per month.

### marketplace_stats_aggregated_usage_trends_count
HEAD /api/marketplace-stats/aggregated_usage_trends/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_component_usages_list
GET /api/marketplace-stats/component_usages/
Summary: Return component usages for current month
Description: Return component usages for current month.

### marketplace_stats_component_usages_count
HEAD /api/marketplace-stats/component_usages/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_component_usages_per_month_list
GET /api/marketplace-stats/component_usages_per_month/
Summary: Return component usages per month
Description: Return component usages per month.

### marketplace_stats_component_usages_per_month_count
HEAD /api/marketplace-stats/component_usages_per_month/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_component_usages_per_project_list
GET /api/marketplace-stats/component_usages_per_project/
Summary: Return component usages per project
Description: Return component usages per project.

### marketplace_stats_component_usages_per_project_count
HEAD /api/marketplace-stats/component_usages_per_project/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_count_active_resources_grouped_by_offering_list
GET /api/marketplace-stats/count_active_resources_grouped_by_offering/
Summary: Count active resources grouped by offering
Description: Count active resources grouped by offering.

### marketplace_stats_count_active_resources_grouped_by_offering_count
HEAD /api/marketplace-stats/count_active_resources_grouped_by_offering/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_count_active_resources_grouped_by_offering_country_list
GET /api/marketplace-stats/count_active_resources_grouped_by_offering_country/
Summary: Count active resources grouped by offering country
Description: Count active resources grouped by offering country.

### marketplace_stats_count_active_resources_grouped_by_offering_country_count
HEAD /api/marketplace-stats/count_active_resources_grouped_by_offering_country/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_count_active_resources_grouped_by_organization_group_list
GET /api/marketplace-stats/count_active_resources_grouped_by_organization_group/
Summary: Count active resources grouped by organization group
Description: Count active resources grouped by organization group.

### marketplace_stats_count_active_resources_grouped_by_organization_group_count
HEAD /api/marketplace-stats/count_active_resources_grouped_by_organization_group/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_count_projects_grouped_by_provider_and_industry_flag_list
GET /api/marketplace-stats/count_projects_grouped_by_provider_and_industry_flag/
Summary: Count projects grouped by provider and industry flag

### marketplace_stats_count_projects_grouped_by_provider_and_industry_flag_count
HEAD /api/marketplace-stats/count_projects_grouped_by_provider_and_industry_flag/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_count_projects_grouped_by_provider_and_oecd_list
GET /api/marketplace-stats/count_projects_grouped_by_provider_and_oecd/
Summary: Count projects grouped by provider and OECD code

### marketplace_stats_count_projects_grouped_by_provider_and_oecd_count
HEAD /api/marketplace-stats/count_projects_grouped_by_provider_and_oecd/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_count_projects_of_service_providers_list
GET /api/marketplace-stats/count_projects_of_service_providers/
Summary: Count projects of service providers
Description: Count projects of service providers.

### marketplace_stats_count_projects_of_service_providers_count
HEAD /api/marketplace-stats/count_projects_of_service_providers/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_count_projects_of_service_providers_grouped_by_oecd_list
GET /api/marketplace-stats/count_projects_of_service_providers_grouped_by_oecd/
Summary: Count projects of service providers grouped by OECD
Description: Count projects of service providers grouped by OECD.

### marketplace_stats_count_projects_of_service_providers_grouped_by_oecd_count
HEAD /api/marketplace-stats/count_projects_of_service_providers_grouped_by_oecd/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_count_unique_users_connected_with_active_resources_of_service_provider_list
GET /api/marketplace-stats/count_unique_users_connected_with_active_resources_of_service_provider/
Summary: Count unique users connected with active resources of service provider
Description: Count unique users connected with active resources of service provider.

### marketplace_stats_count_unique_users_connected_with_active_resources_of_service_provider_count
HEAD /api/marketplace-stats/count_unique_users_connected_with_active_resources_of_service_provider/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_count_users_of_service_providers_list
GET /api/marketplace-stats/count_users_of_service_providers/
Summary: Count users of service providers
Description: Count users of service providers.

### marketplace_stats_count_users_of_service_providers_count
HEAD /api/marketplace-stats/count_users_of_service_providers/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_customer_member_count_list
GET /api/marketplace-stats/customer_member_count/
Summary: Return count of customer members
Description: Return count of customer members.

### marketplace_stats_customer_member_count_count
HEAD /api/marketplace-stats/customer_member_count/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_customer_member_summary_retrieve
GET /api/marketplace-stats/customer_member_summary/
Summary: Return summary statistics for customer members
Description: Return summary statistics for customer members.

### marketplace_stats_customer_member_summary_count
HEAD /api/marketplace-stats/customer_member_summary/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_offering_costs_summary_retrieve
GET /api/marketplace-stats/offering_costs_summary/
Summary: Return summary statistics for offering costs
Description: Return summary statistics for offering costs.

### marketplace_stats_offering_costs_summary_count
HEAD /api/marketplace-stats/offering_costs_summary/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_offerings_counter_stats_list
GET /api/marketplace-stats/offerings_counter_stats/
Summary: Retrieve statistics about the number of offerings, grouped by category and service provider
Description: Retrieve statistics about the number of offerings, grouped by category and service provider.

### marketplace_stats_offerings_counter_stats_count
HEAD /api/marketplace-stats/offerings_counter_stats/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_openstack_instances_list
GET /api/marketplace-stats/openstack_instances/
Summary: List all OpenStack instances with infrastructure details.
Description: Returns a paginated flat list of all OpenStack instances across all clusters. Staff and support users can filter by infrastructure properties.
Query parameters (18):
  - availability_zone_name — Filter by availability zone name.
  - cores_max — Maximum number of vCPUs.
  - cores_min — Minimum number of vCPUs.
  - customer_uuid — Filter by customer UUID.
  - disk_max — Maximum disk in MiB.
  - disk_min — Minimum disk in MiB.
  - flavor_name — Filter by flavor name (case-insensitive partial match).
  - hypervisor_hostname — Filter by hypervisor hostname (case-insensitive partial match).
  - image_name — Filter by image name (case-insensitive partial match).
  - name — Filter by instance name (case-insensitive partial match).
  - o — Ordering field. Prefix with - for descending. Options: name, cores, ram, disk, created, runtime_state, flavor_name, hypervisor_hostname, customer_name, project_name, cluster_name, start_time.
  - project_uuid — Filter by project UUID.
  - ram_max — Maximum RAM in MiB.
  - ram_min — Minimum RAM in MiB.
  - runtime_state — Filter by runtime state (e.g. ACTIVE, SHUTOFF).
  - service_settings_uuid — Filter by cluster (service settings) UUID.
  - state — Filter by provisioning state (e.g. OK, ERRED). Supports multiple values.
  - tenant_uuid — Filter by tenant UUID.

### marketplace_stats_openstack_instances_count
HEAD /api/marketplace-stats/openstack_instances/
Summary: List all OpenStack instances with infrastructure details.
Description: Get number of items in the collection matching the request parameters.
Query parameters (18):
  - availability_zone_name — Filter by availability zone name.
  - cores_max — Maximum number of vCPUs.
  - cores_min — Minimum number of vCPUs.
  - customer_uuid — Filter by customer UUID.
  - disk_max — Maximum disk in MiB.
  - disk_min — Minimum disk in MiB.
  - flavor_name — Filter by flavor name (case-insensitive partial match).
  - hypervisor_hostname — Filter by hypervisor hostname (case-insensitive partial match).
  - image_name — Filter by image name (case-insensitive partial match).
  - name — Filter by instance name (case-insensitive partial match).
  - o — Ordering field. Prefix with - for descending. Options: name, cores, ram, disk, created, runtime_state, flavor_name, hypervisor_hostname, customer_name, project_name, cluster_name, start_time.
  - project_uuid — Filter by project UUID.
  - ram_max — Maximum RAM in MiB.
  - ram_min — Minimum RAM in MiB.
  - runtime_state — Filter by runtime state (e.g. ACTIVE, SHUTOFF).
  - service_settings_uuid — Filter by cluster (service settings) UUID.
  - state — Filter by provisioning state (e.g. OK, ERRED). Supports multiple values.
  - tenant_uuid — Filter by tenant UUID.

### marketplace_stats_openstack_instances_aggregate_list
GET /api/marketplace-stats/openstack_instances_aggregate/
Summary: Aggregate OpenStack instances by a dimension.
Description: Returns aggregated metrics (count, cores, RAM, disk) grouped by the specified dimension.
Query parameters (11):
  - customer_uuid — Filter by customer UUID.
  - flavor_name — Filter by flavor name (case-insensitive partial match).
  - group_by (required) — Dimension to group by.
  - hypervisor_hostname — Filter by hypervisor hostname (case-insensitive partial match).
  - image_name — Filter by image name (case-insensitive partial match).
  - name — Filter by instance name (case-insensitive partial match).
  - project_uuid — Filter by project UUID.
  - runtime_state — Filter by runtime state (e.g. ACTIVE, SHUTOFF).
  - service_settings_uuid — Filter by cluster (service settings) UUID.
  - state — Filter by provisioning state (e.g. OK, ERRED).
  - tenant_uuid — Filter by tenant UUID.

### marketplace_stats_openstack_instances_aggregate_count
HEAD /api/marketplace-stats/openstack_instances_aggregate/
Summary: Aggregate OpenStack instances by a dimension.
Description: Get number of items in the collection matching the request parameters.
Query parameters (11):
  - customer_uuid — Filter by customer UUID.
  - flavor_name — Filter by flavor name (case-insensitive partial match).
  - group_by (required) — Dimension to group by.
  - hypervisor_hostname — Filter by hypervisor hostname (case-insensitive partial match).
  - image_name — Filter by image name (case-insensitive partial match).
  - name — Filter by instance name (case-insensitive partial match).
  - project_uuid — Filter by project UUID.
  - runtime_state — Filter by runtime state (e.g. ACTIVE, SHUTOFF).
  - service_settings_uuid — Filter by cluster (service settings) UUID.
  - state — Filter by provisioning state (e.g. OK, ERRED).
  - tenant_uuid — Filter by tenant UUID.

### marketplace_stats_order_stats_retrieve
GET /api/marketplace-stats/order_stats/
Summary: Return comprehensive order statistics including daily breakdown, state/type aggregations, and summary stats
Description: Return comprehensive order statistics including daily breakdown, state/type aggregations, and summary stats.
Query parameters (4):
  - customer_uuid — Filter by customer UUID.
  - end — End date in YYYY-MM-DD format. Defaults to today.
  - provider_uuid — Filter by service provider UUID.
  - start — Start date in YYYY-MM-DD format. Defaults to 30 days ago.

### marketplace_stats_order_stats_count
HEAD /api/marketplace-stats/order_stats/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - customer_uuid — Filter by customer UUID.
  - end — End date in YYYY-MM-DD format. Defaults to today.
  - provider_uuid — Filter by service provider UUID.
  - start — Start date in YYYY-MM-DD format. Defaults to 30 days ago.

### marketplace_stats_organization_project_count_list
GET /api/marketplace-stats/organization_project_count/
Summary: Return project count per organization
Description: Return project count per organization.

### marketplace_stats_organization_project_count_count
HEAD /api/marketplace-stats/organization_project_count/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_organization_resource_count_list
GET /api/marketplace-stats/organization_resource_count/
Summary: Return resource count per organization
Description: Return resource count per organization.

### marketplace_stats_organization_resource_count_count
HEAD /api/marketplace-stats/organization_resource_count/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_project_classification_summary_retrieve
GET /api/marketplace-stats/project_classification_summary/
Summary: Return summary statistics for project classification
Description: Return summary statistics for project classification.

### marketplace_stats_project_classification_summary_count
HEAD /api/marketplace-stats/project_classification_summary/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_project_creation_trend_list
GET /api/marketplace-stats/project_creation_trend/
Summary: Return project creation counts grouped by month
Description: Return project creation counts grouped by month.

### marketplace_stats_project_creation_trend_count
HEAD /api/marketplace-stats/project_creation_trend/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_projects_limits_grouped_by_industry_flag_retrieve
GET /api/marketplace-stats/projects_limits_grouped_by_industry_flag/
Summary: Group project limits by industry flag
Description: Group project limits by industry flag.

### marketplace_stats_projects_limits_grouped_by_industry_flag_count
HEAD /api/marketplace-stats/projects_limits_grouped_by_industry_flag/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_projects_limits_grouped_by_oecd_retrieve
GET /api/marketplace-stats/projects_limits_grouped_by_oecd/
Summary: Group project limits by OECD code
Description: Group project limits by OECD code.

### marketplace_stats_projects_limits_grouped_by_oecd_count
HEAD /api/marketplace-stats/projects_limits_grouped_by_oecd/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_projects_usages_grouped_by_industry_flag_retrieve
GET /api/marketplace-stats/projects_usages_grouped_by_industry_flag/
Summary: Group project usages by industry flag
Description: Group project usages by industry flag.

### marketplace_stats_projects_usages_grouped_by_industry_flag_count
HEAD /api/marketplace-stats/projects_usages_grouped_by_industry_flag/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_projects_usages_grouped_by_oecd_retrieve
GET /api/marketplace-stats/projects_usages_grouped_by_oecd/
Summary: Group project usages by OECD code
Description: Group project usages by OECD code.

### marketplace_stats_projects_usages_grouped_by_oecd_count
HEAD /api/marketplace-stats/projects_usages_grouped_by_oecd/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_provider_customers_retrieve
GET /api/marketplace-stats/provider_customers/
Summary: Return customer statistics for a service provider
Description: Return customer statistics for a service provider.
Query parameters (1):
  - provider_uuid (required) — Service provider UUID.

### marketplace_stats_provider_customers_count
HEAD /api/marketplace-stats/provider_customers/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - provider_uuid (required) — Service provider UUID.

### marketplace_stats_provider_offerings_retrieve
GET /api/marketplace-stats/provider_offerings/
Summary: Return offering performance statistics for a service provider
Description: Return offering performance statistics for a service provider.
Query parameters (1):
  - provider_uuid (required) — Service provider UUID.

### marketplace_stats_provider_offerings_count
HEAD /api/marketplace-stats/provider_offerings/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - provider_uuid (required) — Service provider UUID.

### marketplace_stats_provider_resources_retrieve
GET /api/marketplace-stats/provider_resources/
Summary: Return resource statistics for a service provider
Description: Return resource statistics for a service provider.
Query parameters (1):
  - provider_uuid (required) — Service provider UUID.

### marketplace_stats_provider_resources_count
HEAD /api/marketplace-stats/provider_resources/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - provider_uuid (required) — Service provider UUID.

### marketplace_stats_resource_creation_trend_list
GET /api/marketplace-stats/resource_creation_trend/
Summary: Return resource creation counts grouped by month
Description: Return resource creation counts grouped by month.

### marketplace_stats_resource_creation_trend_count
HEAD /api/marketplace-stats/resource_creation_trend/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_resource_provisioning_stats_list
GET /api/marketplace-stats/resource_provisioning_stats/
Summary: Get resource provisioning statistics
Description: Get resource provisioning statistics.
Query parameters (1):
  - last_minutes — Filter by last N minutes. Default is 60.

### marketplace_stats_resource_provisioning_stats_count
HEAD /api/marketplace-stats/resource_provisioning_stats/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - last_minutes — Filter by last N minutes. Default is 60.

### marketplace_stats_resource_usage_by_creator_affiliation_list
GET /api/marketplace-stats/resource_usage_by_creator_affiliation/
Summary: Return resource usage grouped by creator's affiliation
Description: Return resource usage grouped by creator's affiliation.

### marketplace_stats_resource_usage_by_creator_affiliation_count
HEAD /api/marketplace-stats/resource_usage_by_creator_affiliation/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_resource_usage_by_customer_list
GET /api/marketplace-stats/resource_usage_by_customer/
Summary: Return resource usage statistics grouped by customer
Description: Return resource usage statistics grouped by customer.

### marketplace_stats_resource_usage_by_customer_count
HEAD /api/marketplace-stats/resource_usage_by_customer/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_resource_usage_by_organization_type_list
GET /api/marketplace-stats/resource_usage_by_organization_type/
Summary: Return component usages grouped by project members' organization type
Description: Return component usages grouped by project members' organization type.

### marketplace_stats_resource_usage_by_organization_type_count
HEAD /api/marketplace-stats/resource_usage_by_organization_type/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_resources_geography_summary_retrieve
GET /api/marketplace-stats/resources_geography_summary/
Summary: Return summary statistics for resource geographic distribution
Description: Return summary statistics for resource geographic distribution.

### marketplace_stats_resources_geography_summary_count
HEAD /api/marketplace-stats/resources_geography_summary/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_resources_limits_list
GET /api/marketplace-stats/resources_limits/
Summary: Return resources limits per offering
Description: Return resources limits per offering.

### marketplace_stats_resources_limits_count
HEAD /api/marketplace-stats/resources_limits/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_resources_missing_usage_list
GET /api/marketplace-stats/resources_missing_usage/
Summary: Return usage-based resources with no usage reported in the specified billing period
Description: Return usage-based resources with no usage reported in the specified billing period.
Query parameters (2):
  - billing_period — Billing period in YYYY-MM format. Defaults to current month.
  - provider_uuid — Filter by service provider UUID.

### marketplace_stats_resources_missing_usage_count
HEAD /api/marketplace-stats/resources_missing_usage/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - billing_period — Billing period in YYYY-MM format. Defaults to current month.
  - provider_uuid — Filter by service provider UUID.

### marketplace_stats_top_service_providers_by_resources_list
GET /api/marketplace-stats/top_service_providers_by_resources/
Summary: Return top service providers by number of active resources
Description: Return top service providers by number of active resources.
Query parameters (1):
  - limit — Number of top providers to return. Default is 5.

### marketplace_stats_top_service_providers_by_resources_count
HEAD /api/marketplace-stats/top_service_providers_by_resources/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - limit — Number of top providers to return. Default is 5.

### marketplace_stats_total_cost_of_active_resources_per_offering_list
GET /api/marketplace-stats/total_cost_of_active_resources_per_offering/
Summary: Total cost of active resources per offering
Description: Total cost of active resources per offering.

### marketplace_stats_total_cost_of_active_resources_per_offering_count
HEAD /api/marketplace-stats/total_cost_of_active_resources_per_offering/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_user_affiliation_count_list
GET /api/marketplace-stats/user_affiliation_count/
Summary: Return user count grouped by affiliation
Description: Return user count grouped by affiliation.

### marketplace_stats_user_affiliation_count_count
HEAD /api/marketplace-stats/user_affiliation_count/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_user_affiliation_details_list
GET /api/marketplace-stats/user_affiliation_details/
Summary: Paginated affiliation rows with parsed organization, country, category and identifier fields
Description: Paginated affiliation rows with parsed organization, country, category and identifier fields. Drives the affiliation details table; the unparsed aggregate counts remain available via user_affiliation_count.
Query parameters (5):
  - category — One of: home-organization, personal-identifier, organization-type, user-status, eduperson, other.
  - country — ISO country code (case-insensitive).
  - o — Ordering field; prefix with - for descending. Allowed: count, organization, country, category, affiliation. Defaults to -count.
  - organization — Exact organization domain match.
  - search — Substring match against raw URN or organization.

### marketplace_stats_user_affiliation_details_count
HEAD /api/marketplace-stats/user_affiliation_details/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - category — One of: home-organization, personal-identifier, organization-type, user-status, eduperson, other.
  - country — ISO country code (case-insensitive).
  - o — Ordering field; prefix with - for descending. Allowed: count, organization, country, category, affiliation. Defaults to -count.
  - organization — Exact organization domain match.
  - search — Substring match against raw URN or organization.

### marketplace_stats_user_auth_method_count_list
GET /api/marketplace-stats/user_auth_method_count/
Summary: Return user count grouped by authentication method
Description: Return user count grouped by authentication method.

### marketplace_stats_user_auth_method_count_count
HEAD /api/marketplace-stats/user_auth_method_count/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_user_identity_source_count_list
GET /api/marketplace-stats/user_identity_source_count/
Summary: Return user count grouped by identity source
Description: Return user count grouped by identity source.

### marketplace_stats_user_identity_source_count_count
HEAD /api/marketplace-stats/user_identity_source_count/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_user_job_title_count_list
GET /api/marketplace-stats/user_job_title_count/
Summary: Return user count grouped by job title
Description: Return user count grouped by job title.

### marketplace_stats_user_job_title_count_count
HEAD /api/marketplace-stats/user_job_title_count/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_user_nationality_list
GET /api/marketplace-stats/user_nationality/
Summary: Return user count per nationality
Description: Return user count per nationality.

### marketplace_stats_user_nationality_count
HEAD /api/marketplace-stats/user_nationality/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_user_organization_count_list
GET /api/marketplace-stats/user_organization_count/
Summary: Return user count grouped by organization
Description: Return user count grouped by organization.

### marketplace_stats_user_organization_count_count
HEAD /api/marketplace-stats/user_organization_count/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_user_organization_type_count_list
GET /api/marketplace-stats/user_organization_type_count/
Summary: Return user count grouped by organization type (SCHAC URN)
Description: Return user count grouped by organization type (SCHAC URN).

### marketplace_stats_user_organization_type_count_count
HEAD /api/marketplace-stats/user_organization_type_count/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### marketplace_stats_user_residence_country_list
GET /api/marketplace-stats/user_residence_country/
Summary: Return user count per residence country
Description: Return user count per residence country.

### marketplace_stats_user_residence_country_count
HEAD /api/marketplace-stats/user_residence_country/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

============================================================
## marketplace-tags  (module: waldur_api_client.api.marketplace_tags)
============================================================

### marketplace_tags_list
GET /api/marketplace-tags/
Query parameters (2):
  - created_by
  - name

### marketplace_tags_count
HEAD /api/marketplace-tags/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - created_by
  - name

### marketplace_tags_create
POST /api/marketplace-tags/
Request body: yes

### marketplace_tags_retrieve
GET /api/marketplace-tags/{uuid}/
Path parameters:
  - uuid

### marketplace_tags_update
PUT /api/marketplace-tags/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_tags_partial_update
PATCH /api/marketplace-tags/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_tags_destroy
DELETE /api/marketplace-tags/{uuid}/
Path parameters:
  - uuid

============================================================
## marketplace-user-offering-consents  (module: waldur_api_client.api.marketplace_user_offering_consents)
============================================================

### marketplace_user_offering_consents_list
GET /api/marketplace-user-offering-consents/
Summary: List user offering consents
Description: Returns a paginated list of Terms of Service consents for the current user. Staff and support users can see all consents.
Query parameters (8):
  - has_consent — Has consent
  - o — Ordering
  - offering — Offering URL
  - offering_uuid — Offering UUID
  - requires_reconsent — Requires reconsent
  - user — User URL
  - user_uuid — User UUID
  - version — Version

### marketplace_user_offering_consents_count
HEAD /api/marketplace-user-offering-consents/
Summary: List user offering consents
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - has_consent — Has consent
  - o — Ordering
  - offering — Offering URL
  - offering_uuid — Offering UUID
  - requires_reconsent — Requires reconsent
  - user — User URL
  - user_uuid — User UUID
  - version — Version

### marketplace_user_offering_consents_create
POST /api/marketplace-user-offering-consents/
Summary: Grant consent to an offering's Terms of Service
Description: Creates a consent record for the current user and a specific offering. This indicates that the user has accepted the active Terms of Service for that offering. If a consent already exists (even if revoked), it will be reactivated and updated with the current ToS version.
Request body: yes

### marketplace_user_offering_consents_retrieve
GET /api/marketplace-user-offering-consents/{uuid}/
Summary: Retrieve a user offering consent
Description: Returns the details of a specific consent record.
Path parameters:
  - uuid

### marketplace_user_offering_consents_update
PUT /api/marketplace-user-offering-consents/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_user_offering_consents_partial_update
PATCH /api/marketplace-user-offering-consents/{uuid}/
Path parameters:
  - uuid
Request body: yes

### marketplace_user_offering_consents_destroy
DELETE /api/marketplace-user-offering-consents/{uuid}/
Path parameters:
  - uuid

### marketplace_user_offering_consents_revoke
POST /api/marketplace-user-offering-consents/{uuid}/revoke/
Summary: Revoke consent to Terms of Service
Description: Revokes a user's consent to the Terms of Service for an offering. The consent record is marked with a revocation date, and the user may lose access to related resources if consent is required.
Path parameters:
  - uuid

============================================================
## matrix  (module: waldur_api_client.api.matrix)
============================================================

### matrix_credentials_retrieve
GET /api/matrix/credentials/
Summary: Get Matrix login credentials
Description: Returns Matrix login credentials for the authenticated user based on the configured login method.

### matrix_exports_list
GET /api/matrix/exports/
Query parameters (3):
  - export_type
  - room_uuid — Room UUID
  - state

### matrix_exports_count
HEAD /api/matrix/exports/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - export_type
  - room_uuid — Room UUID
  - state

### matrix_exports_retrieve
GET /api/matrix/exports/{uuid}/
Path parameters:
  - uuid

### matrix_exports_download_retrieve
GET /api/matrix/exports/{uuid}/download/{kind}/
Summary: Download a Matrix history export file
Path parameters:
  - kind — Which artifact to stream.
  - uuid

### matrix_rooms_list
GET /api/matrix/rooms/
Query parameters (3):
  - member — Only rooms the current user is a member of
  - project_uuid — Project UUID
  - state

### matrix_rooms_count
HEAD /api/matrix/rooms/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - member — Only rooms the current user is a member of
  - project_uuid — Project UUID
  - state

### matrix_rooms_create
POST /api/matrix/rooms/
Summary: Create a Matrix room for a project
Request body: yes

### matrix_rooms_eligible_projects_list
GET /api/matrix/rooms/eligible_projects/
Summary: List projects the caller can create a Matrix room for
Description: Returns projects where the caller is customer owner (staff sees all) and no MatrixRoom row exists yet. Existing archived rooms still block creation, so projects with any room are excluded.
Query parameters (4):
  - customer_uuid — Limit results to projects under this customer.
  - member — Only rooms the current user is a member of
  - project_uuid — Project UUID
  - state

### matrix_rooms_eligible_projects_count
HEAD /api/matrix/rooms/eligible_projects/
Summary: List projects the caller can create a Matrix room for
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - customer_uuid — Limit results to projects under this customer.
  - member — Only rooms the current user is a member of
  - project_uuid — Project UUID
  - state

### matrix_rooms_retrieve
GET /api/matrix/rooms/{uuid}/
Path parameters:
  - uuid

### matrix_rooms_destroy
DELETE /api/matrix/rooms/{uuid}/
Path parameters:
  - uuid

### matrix_rooms_disable
POST /api/matrix/rooms/{uuid}/disable/
Summary: Disable an active chat room
Path parameters:
  - uuid
Request body: yes

### matrix_rooms_export_history
POST /api/matrix/rooms/{uuid}/export_history/
Summary: Trigger manual history export
Path parameters:
  - uuid

### matrix_rooms_join
POST /api/matrix/rooms/{uuid}/join/
Summary: Join a chat room as staff
Description: Staff self-join: provisions the caller, adds them with a Moderator badge (power level 50), and posts a bot announcement.
Path parameters:
  - uuid

### matrix_rooms_leave
POST /api/matrix/rooms/{uuid}/leave/
Summary: Leave a chat room as staff
Description: Staff self-leave: posts a bot announcement and removes the caller from the room.
Path parameters:
  - uuid

### matrix_rooms_members_list
GET /api/matrix/rooms/{uuid}/members/
Summary: List room members
Path parameters:
  - uuid
Query parameters (3):
  - member — Only rooms the current user is a member of
  - project_uuid — Project UUID
  - state

### matrix_rooms_reactivate
POST /api/matrix/rooms/{uuid}/reactivate/
Summary: Re-enable an archived chat room
Path parameters:
  - uuid

### matrix_rooms_retry
POST /api/matrix/rooms/{uuid}/retry/
Summary: Retry a stuck or failed room operation
Path parameters:
  - uuid

### matrix_rooms_sync_members
POST /api/matrix/rooms/{uuid}/sync_members/
Summary: Force sync room membership with project members
Path parameters:
  - uuid

============================================================
## media  (module: waldur_api_client.api.media)
============================================================

### media_retrieve
GET /api/media/{uuid}/
Summary: Get media file
Path parameters:
  - uuid

============================================================
## metadata  (module: waldur_api_client.api.metadata)
============================================================

### metadata_events_retrieve
GET /api/metadata/events/
Summary: Get event metadata
Description: 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.

### metadata_features_retrieve
GET /api/metadata/features/
Summary: Get feature flag metadata
Description: 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.

### metadata_permissions_retrieve
GET /api/metadata/permissions/
Summary: Get permission metadata
Description: 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.

### metadata_settings_retrieve
GET /api/metadata/settings/
Summary: Get overridable settings metadata
Description: 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.

============================================================
## my-assignment-batches  (module: waldur_api_client.api.my_assignment_batches)
============================================================

### my_assignment_batches_list
GET /api/my-assignment-batches/
Summary: List all pending assignment batches for the authenticated reviewer
Description: List all pending assignment batches for the authenticated reviewer.

### my_assignment_batches_count
HEAD /api/my-assignment-batches/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### my_assignment_batches_retrieve
GET /api/my-assignment-batches/{uuid}/
Summary: Get details of a specific assignment batch with items
Description: Get details of a specific assignment batch with items.
Path parameters:
  - uuid — UUID of the assignment batch

============================================================
## notification-messages  (module: waldur_api_client.api.notification_messages)
============================================================

### notification_messages_list
GET /api/notification-messages/
Query parameters (6):
  - description
  - is_overridden — Is overridden
  - key
  - name — Name
  - name_exact — Name (exact)
  - query — Filter by key or description

### notification_messages_count
HEAD /api/notification-messages/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - description
  - is_overridden — Is overridden
  - key
  - name — Name
  - name_exact — Name (exact)
  - query — Filter by key or description

### notification_messages_create
POST /api/notification-messages/
Request body: yes

### notification_messages_retrieve
GET /api/notification-messages/{uuid}/
Path parameters:
  - uuid

### notification_messages_update
PUT /api/notification-messages/{uuid}/
Path parameters:
  - uuid
Request body: yes

### notification_messages_partial_update
PATCH /api/notification-messages/{uuid}/
Path parameters:
  - uuid
Request body: yes

### notification_messages_destroy
DELETE /api/notification-messages/{uuid}/
Path parameters:
  - uuid

### notification_messages_disable
POST /api/notification-messages/{uuid}/disable/
Summary: Disable a notification
Path parameters:
  - uuid

### notification_messages_enable
POST /api/notification-messages/{uuid}/enable/
Summary: Enable a notification
Path parameters:
  - uuid

============================================================
## notification-messages-templates  (module: waldur_api_client.api.notification_messages_templates)
============================================================

### notification_messages_templates_list
GET /api/notification-messages-templates/
Query parameters (5):
  - is_overridden — Is overridden
  - name — Name
  - name_exact — Name (exact)
  - path — Path
  - path_exact — Path (exact)

### notification_messages_templates_count
HEAD /api/notification-messages-templates/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - is_overridden — Is overridden
  - name — Name
  - name_exact — Name (exact)
  - path — Path
  - path_exact — Path (exact)

### notification_messages_templates_create
POST /api/notification-messages-templates/
Request body: yes

### notification_messages_templates_retrieve
GET /api/notification-messages-templates/{uuid}/
Path parameters:
  - uuid

### notification_messages_templates_update
PUT /api/notification-messages-templates/{uuid}/
Path parameters:
  - uuid
Request body: yes

### notification_messages_templates_partial_update
PATCH /api/notification-messages-templates/{uuid}/
Path parameters:
  - uuid
Request body: yes

### notification_messages_templates_destroy
DELETE /api/notification-messages-templates/{uuid}/
Path parameters:
  - uuid

### notification_messages_templates_override
POST /api/notification-messages-templates/{uuid}/override/
Summary: Override notification template content
Path parameters:
  - uuid
Request body: yes

============================================================
## onboarding  (module: waldur_api_client.api.onboarding)
============================================================

### onboarding_person_identifier_fields_retrieve
GET /api/onboarding/person-identifier-fields/
Summary: Return person identifier field specification for a specific validation method
Description: Return person identifier field specification for a specific validation method. The validation_method parameter should match one of the available methods (e.g., 'ariregister', 'wirtschaftscompass', 'bolagsverket', 'breg').
Query parameters (1):
  - validation_method (required) — Validation method identifier

### onboarding_supported_countries_retrieve
GET /api/onboarding/supported-countries/
Summary: Return list of supported countries for validation
Description: Return list of supported countries for validation.

============================================================
## onboarding-justifications  (module: waldur_api_client.api.onboarding_justifications)
============================================================

### onboarding_justifications_list
GET /api/onboarding-justifications/
Query parameters (5):
  - o — Ordering
  - query — Filter by legal name, legal person identifier
  - user_uuid — User UUID
  - validation_decision — Review decision
  - verification_uuid — Verification UUID

### onboarding_justifications_count
HEAD /api/onboarding-justifications/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - o — Ordering
  - query — Filter by legal name, legal person identifier
  - user_uuid — User UUID
  - validation_decision — Review decision
  - verification_uuid — Verification UUID

### onboarding_justifications_create
POST /api/onboarding-justifications/
Request body: yes

### onboarding_justifications_create_justification
POST /api/onboarding-justifications/create_justification/
Summary: Create justification for failed verification
Description: Create justification for failed verification.
Request body: yes

### onboarding_justifications_retrieve
GET /api/onboarding-justifications/{uuid}/
Path parameters:
  - uuid

### onboarding_justifications_update
PUT /api/onboarding-justifications/{uuid}/
Path parameters:
  - uuid
Request body: yes

### onboarding_justifications_partial_update
PATCH /api/onboarding-justifications/{uuid}/
Path parameters:
  - uuid
Request body: yes

### onboarding_justifications_destroy
DELETE /api/onboarding-justifications/{uuid}/
Path parameters:
  - uuid

### onboarding_justifications_approve
POST /api/onboarding-justifications/{uuid}/approve/
Summary: Approve justification and mark verification as VERIFIED
Description: Approve justification and mark verification as VERIFIED.
Path parameters:
  - uuid
Request body: yes

### onboarding_justifications_attach_document
POST /api/onboarding-justifications/{uuid}/attach_document/
Summary: Attach supporting document to justification
Description: Attach supporting document to justification.
Path parameters:
  - uuid
Request body: yes

### onboarding_justifications_reject
POST /api/onboarding-justifications/{uuid}/reject/
Summary: Reject justification and mark verification as FAILED
Description: Reject justification and mark verification as FAILED.
Path parameters:
  - uuid
Request body: yes

============================================================
## onboarding-question-metadata  (module: waldur_api_client.api.onboarding_question_metadata)
============================================================

### onboarding_question_metadata_list
GET /api/onboarding-question-metadata/
Query parameters (5):
  - checklist_uuid — Checklist uuid
  - intent_field
  - maps_to_customer_field
  - question_description
  - question_uuid

### onboarding_question_metadata_count
HEAD /api/onboarding-question-metadata/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - checklist_uuid — Checklist uuid
  - intent_field
  - maps_to_customer_field
  - question_description
  - question_uuid

### onboarding_question_metadata_create
POST /api/onboarding-question-metadata/
Request body: yes

### onboarding_question_metadata_retrieve
GET /api/onboarding-question-metadata/{uuid}/
Path parameters:
  - uuid

### onboarding_question_metadata_update
PUT /api/onboarding-question-metadata/{uuid}/
Path parameters:
  - uuid
Request body: yes

### onboarding_question_metadata_partial_update
PATCH /api/onboarding-question-metadata/{uuid}/
Path parameters:
  - uuid
Request body: yes

### onboarding_question_metadata_destroy
DELETE /api/onboarding-question-metadata/{uuid}/
Path parameters:
  - uuid

============================================================
## onboarding-verifications  (module: waldur_api_client.api.onboarding_verifications)
============================================================

### onboarding_verifications_list
GET /api/onboarding-verifications/
Query parameters (8):
  - country
  - legal_name
  - legal_person_identifier
  - o — Ordering
  - query — Filter by legal name, legal person identifier
  - status — Verification status
  - user_uuid — User UUID
  - validation_method — Validation method

### onboarding_verifications_count
HEAD /api/onboarding-verifications/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - country
  - legal_name
  - legal_person_identifier
  - o — Ordering
  - query — Filter by legal name, legal person identifier
  - status — Verification status
  - user_uuid — User UUID
  - validation_method — Validation method

### onboarding_verifications_create
POST /api/onboarding-verifications/
Request body: yes

### onboarding_verifications_available_checklists_retrieve
GET /api/onboarding-verifications/available_checklists/
Summary: Get available onboarding checklists (customer and intent) for preview
Description: Get available onboarding checklists (customer and intent) for preview. This endpoint allows users to see checklist questions before creating a verification. Supports checklist_type parameter to filter by customer or intent checklists. Includes questions with onboarding metadata (field mappings).
Query parameters (1):
  - checklist_type — Type of checklist to retrieve (customer, intent, or all). Defaults to all.

### onboarding_verifications_available_checklists_count
HEAD /api/onboarding-verifications/available_checklists/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - checklist_type — Type of checklist to retrieve (customer, intent, or all). Defaults to all.

### onboarding_verifications_checklist_template_retrieve
GET /api/onboarding-verifications/checklist-template/
Summary: Get checklist template for creating new objects
Description: Get checklist template for creating new objects.
Query parameters (1):
  - parent_uuid (required) — UUID of the parent object (e.g., customer UUID for new projects)

### onboarding_verifications_checklist_template_count
HEAD /api/onboarding-verifications/checklist-template/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - parent_uuid (required) — UUID of the parent object (e.g., customer UUID for new projects)

### onboarding_verifications_start_verification
POST /api/onboarding-verifications/start_verification/
Summary: Start company validation process by creating a verification record
Description: Start company validation process by creating a verification record. User selects validation_method (e.g., 'ariregister', 'wirtschaftscompass'). Checklists are used for intent and customer data collection. Then call run_validation to perform automatic validation or create manual justification.
Request body: yes

### onboarding_verifications_retrieve
GET /api/onboarding-verifications/{uuid}/
Path parameters:
  - uuid

### onboarding_verifications_update
PUT /api/onboarding-verifications/{uuid}/
Path parameters:
  - uuid
Request body: yes

### onboarding_verifications_partial_update
PATCH /api/onboarding-verifications/{uuid}/
Path parameters:
  - uuid
Request body: yes

### onboarding_verifications_destroy
DELETE /api/onboarding-verifications/{uuid}/
Path parameters:
  - uuid

### onboarding_verifications_checklist_retrieve
GET /api/onboarding-verifications/{uuid}/checklist/
Summary: Get checklist with questions and existing answers
Description: Get checklist with questions and existing answers. Supports both customer and intent checklists via checklist_type parameter.
Path parameters:
  - uuid
Query parameters (2):
  - checklist_type — Type of checklist to retrieve (customer or intent). Defaults to intent.
  - include_all — If true, returns all questions including hidden ones.

### onboarding_verifications_completion_status_retrieve
GET /api/onboarding-verifications/{uuid}/completion_status/
Summary: Get checklist completion status
Description: Get checklist completion status. Supports both customer and intent checklists via checklist_type parameter.
Path parameters:
  - uuid
Query parameters (1):
  - checklist_type — Type of checklist to retrieve (customer or intent). Defaults to intent.

### onboarding_verifications_create_customer
POST /api/onboarding-verifications/{uuid}/create_customer/
Summary: Create customer from successful verification
Description: Create customer from successful verification.
Path parameters:
  - uuid

### onboarding_verifications_run_validation
POST /api/onboarding-verifications/{uuid}/run_validation/
Summary: Run automatic validation using the required fields provided during verification creation
Description: Run automatic validation using the required fields provided during verification creation. Checklist answers (if any) are only used for supplemental customer/intent data.
Path parameters:
  - uuid
Request body: yes

### onboarding_verifications_submit_answers
POST /api/onboarding-verifications/{uuid}/submit_answers/
Summary: Submit answers to checklist questions
Description: Submit answers to checklist questions. Automatically detects which checklist (customer or intent) each question belongs to.
Path parameters:
  - uuid
Request body: yes

============================================================
## openportal  (module: waldur_api_client.api.openportal)
============================================================

### openportal_access_for_email_list
GET /api/openportal/access_for_email/
Query parameters (1):
  - q (required) — Free text search query (email, short_name, project_name, or project_id)

### openportal_offering_mapping_retrieve
GET /api/openportal/offering_mapping/
Summary: Map OpenPortal destination strings to Waldur Offering objects
Description: Map OpenPortal destination strings to Waldur Offering objects. Pass each destination as a repeated 'identifier' query parameter. Returns a dict keyed by identifier; unknown destinations map to null. Accessible to all authenticated users.
Query parameters (1):
  - identifier — OpenPortal destination string (repeatable).

### openportal_project_mapping_retrieve
GET /api/openportal/project_mapping/
Summary: Map OpenPortal ProjectIdentifier strings to Waldur Project objects
Description: Map OpenPortal ProjectIdentifier strings to Waldur Project objects. Pass each identifier as a repeated 'identifier' query parameter. Returns a dict keyed by identifier; unknown identifiers map to null. Staff and support see all projects; regular users see only projects they are a member of.
Query parameters (1):
  - identifier — OpenPortal ProjectIdentifier string (repeatable).

### openportal_user_mapping_retrieve
GET /api/openportal/user_mapping/
Summary: Map OpenPortal UserIdentifier strings (or email addresses) to Waldur User objects
Description: Map OpenPortal UserIdentifier strings (or email addresses) to Waldur User objects. Pass each value as a repeated 'identifier' query parameter. If the values contain '@' they are treated as email addresses (used for cached reports from remote portals); otherwise they are treated as UserIdentifier ...
Query parameters (1):
  - identifier — OpenPortal UserIdentifier string or email address (repeatable). All values in a single request must be the same type.

============================================================
## openportal-accounting-summary  (module: waldur_api_client.api.openportal_accounting_summary)
============================================================

### openportal_accounting_summary_list
GET /api/openportal-accounting-summary/
Query parameters (3):
  - customer_uuid
  - is_active
  - project_uuid

### openportal_accounting_summary_count
HEAD /api/openportal-accounting-summary/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - customer_uuid
  - is_active
  - project_uuid

### openportal_accounting_summary_retrieve
GET /api/openportal-accounting-summary/{uuid}/
Path parameters:
  - uuid

============================================================
## openportal-allocation-user-usage  (module: waldur_api_client.api.openportal_allocation_user_usage)
============================================================

### openportal_allocation_user_usage_list
GET /api/openportal-allocation-user-usage/
Query parameters (6):
  - allocation
  - allocation_uuid
  - month
  - user
  - user_uuid
  - year

### openportal_allocation_user_usage_count
HEAD /api/openportal-allocation-user-usage/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - allocation
  - allocation_uuid
  - month
  - user
  - user_uuid
  - year

### openportal_allocation_user_usage_retrieve
GET /api/openportal-allocation-user-usage/{id}/
Path parameters:
  - id — A unique integer value identifying this allocation user usage.

============================================================
## openportal-allocations  (module: waldur_api_client.api.openportal_allocations)
============================================================

### openportal_allocations_list
GET /api/openportal-allocations/
Query parameters (19):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - is_active
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### openportal_allocations_count
HEAD /api/openportal-allocations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (18):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - is_active
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### openportal_allocations_create
POST /api/openportal-allocations/
Request body: yes

### openportal_allocations_retrieve
GET /api/openportal-allocations/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### openportal_allocations_update
PUT /api/openportal-allocations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### openportal_allocations_partial_update
PATCH /api/openportal-allocations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### openportal_allocations_destroy
DELETE /api/openportal-allocations/{uuid}/
Path parameters:
  - uuid

### openportal_allocations_pull
POST /api/openportal-allocations/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openportal_allocations_set_erred
POST /api/openportal-allocations/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openportal_allocations_set_limits
POST /api/openportal-allocations/{uuid}/set_limits/
Path parameters:
  - uuid
Request body: yes

### openportal_allocations_set_ok
POST /api/openportal-allocations/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openportal_allocations_unlink
POST /api/openportal-allocations/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## openportal-associations  (module: waldur_api_client.api.openportal_associations)
============================================================

### openportal_associations_list
GET /api/openportal-associations/
Query parameters (2):
  - allocation
  - allocation_uuid

### openportal_associations_count
HEAD /api/openportal-associations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - allocation
  - allocation_uuid

### openportal_associations_retrieve
GET /api/openportal-associations/{uuid}/
Path parameters:
  - uuid

============================================================
## openportal-managed-projects  (module: waldur_api_client.api.openportal_managed_projects)
============================================================

### openportal_managed_projects_list
GET /api/openportal-managed-projects/
Summary: List all managed projects
Query parameters (9):
  - identifier
  - local_identifier
  - o — Which field to use when ordering the results.
  - project
  - project_template
  - project_template_uuid
  - project_uuid
  - query
  - state

### openportal_managed_projects_count
HEAD /api/openportal-managed-projects/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - identifier
  - local_identifier
  - o — Which field to use when ordering the results.
  - project
  - project_template
  - project_template_uuid
  - project_uuid
  - query
  - state

### openportal_managed_projects_retrieve_get
GET /api/openportal-managed-projects/{identifier}/{destination}/
Summary: Retrieve a managed project
Path parameters:
  - destination — The destination of the managed project
  - identifier — The identifier of the managed project

### openportal_managed_projects_retrieve_head
HEAD /api/openportal-managed-projects/{identifier}/{destination}/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - destination — The destination of the managed project
  - identifier — The identifier of the managed project

### openportal_managed_projects_approve
POST /api/openportal-managed-projects/{identifier}/{destination}/approve/
Summary: Approve managed project request
Path parameters:
  - destination — The destination of the managed project
  - identifier — The identifier of the managed project
Request body: yes

### openportal_managed_projects_attach
POST /api/openportal-managed-projects/{identifier}/{destination}/attach/
Summary: Attach a project to this managed project
Path parameters:
  - destination — The destination of the managed project
  - identifier — The identifier of the managed project
Request body: yes

### openportal_managed_projects_delete_destroy
DELETE /api/openportal-managed-projects/{identifier}/{destination}/delete/
Summary: Delete ManagedProject object
Path parameters:
  - destination — The destination of the managed project
  - identifier — The identifier of the managed project

### openportal_managed_projects_detach
POST /api/openportal-managed-projects/{identifier}/{destination}/detach/
Summary: Detach the project from this managed project
Path parameters:
  - destination — The destination of the managed project
  - identifier — The identifier of the managed project

### openportal_managed_projects_reject
POST /api/openportal-managed-projects/{identifier}/{destination}/reject/
Summary: Reject managed project request
Path parameters:
  - destination — The destination of the managed project
  - identifier — The identifier of the managed project
Request body: yes

============================================================
## openportal-project-storage-reports  (module: waldur_api_client.api.openportal_project_storage_reports)
============================================================

### openportal_project_storage_reports_list
GET /api/openportal-project-storage-reports/
Query parameters (5):
  - month
  - project_identifier
  - project_uuid
  - resource
  - year

### openportal_project_storage_reports_count
HEAD /api/openportal-project-storage-reports/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - month
  - project_identifier
  - project_uuid
  - resource
  - year

### openportal_project_storage_reports_retrieve
GET /api/openportal-project-storage-reports/{id}/
Path parameters:
  - id — A unique integer value identifying this cached project storage report.

============================================================
## openportal-project-template  (module: waldur_api_client.api.openportal_project_template)
============================================================

### openportal_project_template_list
GET /api/openportal-project-template/
Query parameters (3):
  - name
  - portal
  - uuid

### openportal_project_template_count
HEAD /api/openportal-project-template/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - name
  - portal
  - uuid

### openportal_project_template_create
POST /api/openportal-project-template/
Summary: Create ProjectTemplate object
Request body: yes

### openportal_project_template_retrieve
GET /api/openportal-project-template/{uuid}/
Path parameters:
  - uuid

### openportal_project_template_update
PUT /api/openportal-project-template/{uuid}/
Summary: Update ProjectTemplate object (full update)
Path parameters:
  - uuid
Request body: yes

### openportal_project_template_partial_update
PATCH /api/openportal-project-template/{uuid}/
Summary: Partially update ProjectTemplate object
Path parameters:
  - uuid
Request body: yes

### openportal_project_template_destroy
DELETE /api/openportal-project-template/{uuid}/
Path parameters:
  - uuid

### openportal_project_template_delete_destroy
DELETE /api/openportal-project-template/{uuid}/delete/
Summary: Delete ProjectTemplate object
Path parameters:
  - uuid

============================================================
## openportal-project-usage-reports  (module: waldur_api_client.api.openportal_project_usage_reports)
============================================================

### openportal_project_usage_reports_list
GET /api/openportal-project-usage-reports/
Query parameters (6):
  - is_complete
  - month
  - project_identifier
  - project_uuid
  - resource
  - year

### openportal_project_usage_reports_count
HEAD /api/openportal-project-usage-reports/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - is_complete
  - month
  - project_identifier
  - project_uuid
  - resource
  - year

### openportal_project_usage_reports_retrieve
GET /api/openportal-project-usage-reports/{id}/
Path parameters:
  - id — A unique integer value identifying this cached project usage report.

============================================================
## openportal-projectinfo  (module: waldur_api_client.api.openportal_projectinfo)
============================================================

### openportal_projectinfo_list
GET /api/openportal-projectinfo/
Query parameters (2):
  - project
  - project_uuid

### openportal_projectinfo_count
HEAD /api/openportal-projectinfo/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - project
  - project_uuid

### openportal_projectinfo_create
POST /api/openportal-projectinfo/
Request body: yes

### openportal_projectinfo_retrieve
GET /api/openportal-projectinfo/{project}/
Path parameters:
  - project

### openportal_projectinfo_update
PUT /api/openportal-projectinfo/{project}/
Path parameters:
  - project
Request body: yes

### openportal_projectinfo_partial_update
PATCH /api/openportal-projectinfo/{project}/
Path parameters:
  - project
Request body: yes

### openportal_projectinfo_destroy
DELETE /api/openportal-projectinfo/{project}/
Path parameters:
  - project

### openportal_projectinfo_set_allowed_destinations_update
PUT /api/openportal-projectinfo/{project}/set_allowed_destinations/
Path parameters:
  - project
Request body: yes

### openportal_projectinfo_set_shortname_update
PUT /api/openportal-projectinfo/{project}/set_shortname/
Path parameters:
  - project
Request body: yes

============================================================
## openportal-remote-allocations  (module: waldur_api_client.api.openportal_remote_allocations)
============================================================

### openportal_remote_allocations_list
GET /api/openportal-remote-allocations/
Query parameters (19):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - is_active
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### openportal_remote_allocations_count
HEAD /api/openportal-remote-allocations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (18):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - is_active
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### openportal_remote_allocations_create
POST /api/openportal-remote-allocations/
Request body: yes

### openportal_remote_allocations_retrieve
GET /api/openportal-remote-allocations/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### openportal_remote_allocations_update
PUT /api/openportal-remote-allocations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### openportal_remote_allocations_partial_update
PATCH /api/openportal-remote-allocations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### openportal_remote_allocations_destroy
DELETE /api/openportal-remote-allocations/{uuid}/
Path parameters:
  - uuid

### openportal_remote_allocations_pull
POST /api/openportal-remote-allocations/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openportal_remote_allocations_set_erred
POST /api/openportal-remote-allocations/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openportal_remote_allocations_set_limits
POST /api/openportal-remote-allocations/{uuid}/set_limits/
Path parameters:
  - uuid
Request body: yes

### openportal_remote_allocations_set_ok
POST /api/openportal-remote-allocations/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openportal_remote_allocations_unlink
POST /api/openportal-remote-allocations/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## openportal-remote-associations  (module: waldur_api_client.api.openportal_remote_associations)
============================================================

### openportal_remote_associations_list
GET /api/openportal-remote-associations/
Query parameters (2):
  - allocation
  - allocation_uuid

### openportal_remote_associations_count
HEAD /api/openportal-remote-associations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - allocation
  - allocation_uuid

### openportal_remote_associations_retrieve
GET /api/openportal-remote-associations/{uuid}/
Path parameters:
  - uuid

============================================================
## openportal-unmanaged-projects  (module: waldur_api_client.api.openportal_unmanaged_projects)
============================================================

### openportal_unmanaged_projects_list
GET /api/openportal-unmanaged-projects/
Summary: List projects
Description: Retrieve a list of projects. The list is filtered based on the user's permissions. By default, only active projects are shown.
Query parameters (30):
  - accounting_is_running — Filter by whether accounting is running.
  - affiliation_name — Affiliation name
  - affiliation_uuid — Affiliation UUID
  - backend_id
  - can_admin — Return a list of projects where current user is admin.
  - can_manage — Return a list of projects where current user is manager or a customer owner.
  - conceal_finished_projects — Conceal finished projects
  - created — Created after
  - created_before — Created before
  - current_user_has_role — Multiple values may be separated by commas.
  - customer — Multiple values may be separated by commas.
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - description — Description
  - field
  - has_affiliation — Filter projects that have an affiliation.
  - include_terminated — Include soft-deleted (terminated) projects. Only available to staff and support users, or users with organizational roles who can see their terminated projects.
  - is_removed — Is removed
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - query — Filter by name, slug, UUID, backend ID or resource effective ID
  - science_domain_uuid — Science domain UUID
  - science_sub_domain_uuid — Science sub-domain UUID
  - slug — Slug
  - user_uuid — Filter by user UUID.
  - user_uuid_with_active_role — Filter projects where the given user has a role.

### openportal_unmanaged_projects_count
HEAD /api/openportal-unmanaged-projects/
Summary: List projects
Description: Get number of items in the collection matching the request parameters.
Query parameters (29):
  - accounting_is_running — Filter by whether accounting is running.
  - affiliation_name — Affiliation name
  - affiliation_uuid — Affiliation UUID
  - backend_id
  - can_admin — Return a list of projects where current user is admin.
  - can_manage — Return a list of projects where current user is manager or a customer owner.
  - conceal_finished_projects — Conceal finished projects
  - created — Created after
  - created_before — Created before
  - current_user_has_role — Multiple values may be separated by commas.
  - customer — Multiple values may be separated by commas.
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - description — Description
  - has_affiliation — Filter projects that have an affiliation.
  - include_terminated — Include soft-deleted (terminated) projects. Only available to staff and support users, or users with organizational roles who can see their terminated projects.
  - is_removed — Is removed
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - query — Filter by name, slug, UUID, backend ID or resource effective ID
  - science_domain_uuid — Science domain UUID
  - science_sub_domain_uuid — Science sub-domain UUID
  - slug — Slug
  - user_uuid — Filter by user UUID.
  - user_uuid_with_active_role — Filter projects where the given user has a role.

### openportal_unmanaged_projects_create
POST /api/openportal-unmanaged-projects/
Summary: Create a new project
Description: A new project can be created by users with staff privilege (is_staff=True) or customer owners. Project resource quota is optional.
Request body: yes

### openportal_unmanaged_projects_checklist_template_retrieve
GET /api/openportal-unmanaged-projects/checklist-template/
Summary: Get checklist template for creating new objects
Description: Get checklist template for creating new objects.
Query parameters (1):
  - parent_uuid (required) — UUID of the parent object (e.g., customer UUID for new projects)

### openportal_unmanaged_projects_checklist_template_count
HEAD /api/openportal-unmanaged-projects/checklist-template/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - parent_uuid (required) — UUID of the parent object (e.g., customer UUID for new projects)

### openportal_unmanaged_projects_retrieve
GET /api/openportal-unmanaged-projects/{uuid}/
Summary: Retrieve project details
Description: Fetch the details of a specific project by its UUID. Users can access details of terminated projects they previously had access to.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openportal_unmanaged_projects_update
PUT /api/openportal-unmanaged-projects/{uuid}/
Summary: Update project details
Description: Update the details of a project. Requires project administrator or customer owner permissions.
Path parameters:
  - uuid
Request body: yes

### openportal_unmanaged_projects_partial_update
PATCH /api/openportal-unmanaged-projects/{uuid}/
Summary: Partially update project details
Description: Partially update the details of a project. Requires project administrator or customer owner permissions.
Path parameters:
  - uuid
Request body: yes

### openportal_unmanaged_projects_destroy
DELETE /api/openportal-unmanaged-projects/{uuid}/
Summary: Delete a project
Description: Delete a project. If the project has any active resources, the deletion request will fail with a 409 Conflict response. This action performs a soft-delete, and the project can be recovered later.
Path parameters:
  - uuid

### openportal_unmanaged_projects_add_user
POST /api/openportal-unmanaged-projects/{uuid}/add_user/
Summary: Grant a role to a user
Description: Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
Path parameters:
  - uuid
Request body: yes

### openportal_unmanaged_projects_checklist_retrieve
GET /api/openportal-unmanaged-projects/{uuid}/checklist/
Summary: Get checklist with questions and existing answers
Description: Get checklist with questions and existing answers.
Path parameters:
  - uuid
Query parameters (1):
  - include_all — If true, returns all questions including hidden ones (for dynamic form visibility). Default: false.

### openportal_unmanaged_projects_completion_status_retrieve
GET /api/openportal-unmanaged-projects/{uuid}/completion_status/
Summary: Get checklist completion status
Description: Get checklist completion status.
Path parameters:
  - uuid

### openportal_unmanaged_projects_delete_user
POST /api/openportal-unmanaged-projects/{uuid}/delete_user/
Summary: Revoke a role from a user
Description: Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
Path parameters:
  - uuid
Request body: yes

### openportal_unmanaged_projects_list_users_list
GET /api/openportal-unmanaged-projects/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### openportal_unmanaged_projects_list_users_count
HEAD /api/openportal-unmanaged-projects/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### openportal_unmanaged_projects_move_project
POST /api/openportal-unmanaged-projects/{uuid}/move_project/
Summary: Move project to another customer
Description: Moves a project and its associated resources to a different customer. You can choose whether to preserve existing project permissions for users. Terminated projects can also be moved.
Path parameters:
  - uuid
Request body: yes

### openportal_unmanaged_projects_recover
POST /api/openportal-unmanaged-projects/{uuid}/recover/
Summary: Recover a soft-deleted project
Description: Recovers a soft-deleted (terminated) project, making it active again. Provides options to restore previous team members automatically (staff-only) or send them new invitations.
Path parameters:
  - uuid
Request body: yes

### openportal_unmanaged_projects_stats_retrieve
GET /api/openportal-unmanaged-projects/{uuid}/stats/
Summary: Get project resource usage statistics
Description: Provides statistics about the resource usage (e.g., CPU, RAM, storage) for all resources within a project. Can be filtered to show usage for the current month only.
Path parameters:
  - uuid
Query parameters (1):
  - for_current_month — If true, returns usage data for the current month only. Otherwise, returns total usage.

### openportal_unmanaged_projects_submit_answers
POST /api/openportal-unmanaged-projects/{uuid}/submit_answers/
Summary: Submit checklist answers
Description: Submit checklist answers.
Path parameters:
  - uuid
Request body: yes

### openportal_unmanaged_projects_update_affiliation
POST /api/openportal-unmanaged-projects/{uuid}/update_affiliation/
Summary: Update affiliation for a project
Description: Assigns the project to a single affiliation (or clears it when null).
Path parameters:
  - uuid
Request body: yes

### openportal_unmanaged_projects_update_user
POST /api/openportal-unmanaged-projects/{uuid}/update_user/
Summary: Update a user's role expiration
Description: Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
Path parameters:
  - uuid
Request body: yes

============================================================
## openportal-userinfo  (module: waldur_api_client.api.openportal_userinfo)
============================================================

### openportal_userinfo_list
GET /api/openportal-userinfo/
Query parameters (2):
  - user
  - user_uuid

### openportal_userinfo_count
HEAD /api/openportal-userinfo/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - user
  - user_uuid

### openportal_userinfo_create
POST /api/openportal-userinfo/
Request body: yes

### openportal_userinfo_me_retrieve
GET /api/openportal-userinfo/me/

### openportal_userinfo_me_count
HEAD /api/openportal-userinfo/me/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### openportal_userinfo_retrieve
GET /api/openportal-userinfo/{user}/
Path parameters:
  - user

### openportal_userinfo_update
PUT /api/openportal-userinfo/{user}/
Path parameters:
  - user
Request body: yes

### openportal_userinfo_partial_update
PATCH /api/openportal-userinfo/{user}/
Path parameters:
  - user
Request body: yes

### openportal_userinfo_destroy
DELETE /api/openportal-userinfo/{user}/
Path parameters:
  - user

### openportal_userinfo_set_shortname_update
PUT /api/openportal-userinfo/{user}/set_shortname/
Path parameters:
  - user
Request body: yes

============================================================
## openstack  (module: waldur_api_client.api.openstack)
============================================================

### openstack_discovery_list
GET /api/openstack/discovery/

### openstack_discovery_create
POST /api/openstack/discovery/

### openstack_discovery_discover_external_networks
POST /api/openstack/discovery/discover_external_networks/
Summary: Discover available external networks
Description: Discover available external networks.
Request body: yes

### openstack_discovery_discover_flavors
POST /api/openstack/discovery/discover_flavors/
Summary: Discover available flavors
Description: Discover available flavors.
Request body: yes

### openstack_discovery_discover_instance_availability_zones
POST /api/openstack/discovery/discover_instance_availability_zones/
Summary: Discover available Nova instance availability zones
Description: Discover available Nova instance availability zones.
Request body: yes

### openstack_discovery_discover_volume_availability_zones
POST /api/openstack/discovery/discover_volume_availability_zones/
Summary: Discover available Cinder volume availability zones
Description: Discover available Cinder volume availability zones.
Request body: yes

### openstack_discovery_discover_volume_types
POST /api/openstack/discovery/discover_volume_types/
Summary: Discover available volume types
Description: Discover available volume types.
Request body: yes

### openstack_discovery_preview_service_attributes
POST /api/openstack/discovery/preview_service_attributes/
Summary: Build service_attributes and plugin_options from selected values
Description: Build service_attributes and plugin_options from selected values.
Request body: yes

### openstack_discovery_validate_credentials
POST /api/openstack/discovery/validate_credentials/
Summary: Validate OpenStack credentials without saving them
Description: Validate OpenStack credentials without saving them.
Request body: yes

### openstack_discovery_retrieve
GET /api/openstack/discovery/{id}/
Path parameters:
  - id — A unique integer value identifying this Service provider.

### openstack_discovery_update
PUT /api/openstack/discovery/{id}/
Path parameters:
  - id — A unique integer value identifying this Service provider.

### openstack_discovery_partial_update
PATCH /api/openstack/discovery/{id}/
Path parameters:
  - id — A unique integer value identifying this Service provider.

### openstack_discovery_destroy
DELETE /api/openstack/discovery/{id}/
Path parameters:
  - id — A unique integer value identifying this Service provider.

============================================================
## openstack-backups  (module: waldur_api_client.api.openstack_backups)
============================================================

### openstack_backups_list
GET /api/openstack-backups/
Summary: List backups
Description: Get a list of instance backups.
Query parameters (22):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - instance — Instance URL
  - instance_uuid — Instance UUID
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_backups_count
HEAD /api/openstack-backups/
Summary: List backups
Description: Get number of items in the collection matching the request parameters.
Query parameters (21):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - instance — Instance URL
  - instance_uuid — Instance UUID
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_backups_retrieve
GET /api/openstack-backups/{uuid}/
Summary: Get backup details
Description: Retrieve details of a specific instance backup.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_backups_update
PUT /api/openstack-backups/{uuid}/
Summary: Update backup
Description: Update an existing instance backup.
Path parameters:
  - uuid
Request body: yes

### openstack_backups_partial_update
PATCH /api/openstack-backups/{uuid}/
Summary: Partially update backup
Description: Update specific fields of an instance backup.
Path parameters:
  - uuid
Request body: yes

### openstack_backups_destroy
DELETE /api/openstack-backups/{uuid}/
Summary: Delete backup
Description: Delete an instance backup.
Path parameters:
  - uuid

### openstack_backups_pull
POST /api/openstack-backups/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openstack_backups_restore
POST /api/openstack-backups/{uuid}/restore/
Summary: Restore instance from backup
Path parameters:
  - uuid
Request body: yes

### openstack_backups_set_erred
POST /api/openstack-backups/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openstack_backups_set_ok
POST /api/openstack-backups/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openstack_backups_unlink
POST /api/openstack-backups/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## openstack-external-networks  (module: waldur_api_client.api.openstack_external_networks)
============================================================

### openstack_external_networks_list
GET /api/openstack-external-networks/
Summary: List external networks
Description: Get a list of provider-level external networks discovered from OpenStack.
Query parameters (5):
  - field
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### openstack_external_networks_count
HEAD /api/openstack-external-networks/
Summary: List external networks
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### openstack_external_networks_retrieve
GET /api/openstack-external-networks/{uuid}/
Summary: Get external network details
Description: Retrieve details of a specific external network, including its subnets.
Path parameters:
  - uuid
Query parameters (1):
  - field

============================================================
## openstack-flavors  (module: waldur_api_client.api.openstack_flavors)
============================================================

### openstack_flavors_list
GET /api/openstack-flavors/
Summary: List flavors
Description: Get a list of available VM instance flavors.
Query parameters (19):
  - cores
  - cores__gte
  - cores__lte
  - disk
  - disk__gte
  - disk__lte
  - field
  - name — Name
  - name_exact — Name (exact)
  - name_iregex — Name (regex)
  - o — Ordering
  - offering_uuid — Offering UUID
  - ram
  - ram__gte
  - ram__lte
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_flavors_count
HEAD /api/openstack-flavors/
Summary: List flavors
Description: Get number of items in the collection matching the request parameters.
Query parameters (18):
  - cores
  - cores__gte
  - cores__lte
  - disk
  - disk__gte
  - disk__lte
  - name — Name
  - name_exact — Name (exact)
  - name_iregex — Name (regex)
  - o — Ordering
  - offering_uuid — Offering UUID
  - ram
  - ram__gte
  - ram__lte
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_flavors_usage_stats_retrieve
GET /api/openstack-flavors/usage_stats/
Summary: Get flavor usage statistics
Description: Retrieve usage statistics for VM instance flavors, showing running and created instance counts for each flavor.

### openstack_flavors_usage_stats_count
HEAD /api/openstack-flavors/usage_stats/
Summary: Get flavor usage statistics
Description: Get number of items in the collection matching the request parameters.

### openstack_flavors_retrieve
GET /api/openstack-flavors/{uuid}/
Summary: Get flavor details
Description: Retrieve details of a specific VM instance flavor.
Path parameters:
  - uuid
Query parameters (1):
  - field

============================================================
## openstack-floating-ips  (module: waldur_api_client.api.openstack_floating_ips)
============================================================

### openstack_floating_ips_list
GET /api/openstack-floating-ips/
Summary: List floating IPs
Description: Get a list of floating IP addresses. Status *DOWN* means that floating IP is not linked to a VM, status *ACTIVE* means that it is in use.
Query parameters (23):
  - address
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - free — Is free
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - runtime_state
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_floating_ips_count
HEAD /api/openstack-floating-ips/
Summary: List floating IPs
Description: Get number of items in the collection matching the request parameters.
Query parameters (22):
  - address
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - free — Is free
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - runtime_state
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_floating_ips_retrieve
GET /api/openstack-floating-ips/{uuid}/
Summary: Get floating IP details
Description: Retrieve details of a specific floating IP address.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_floating_ips_destroy
DELETE /api/openstack-floating-ips/{uuid}/
Summary: Delete floating IP
Description: Delete a floating IP address.
Path parameters:
  - uuid

### openstack_floating_ips_attach_to_port
POST /api/openstack-floating-ips/{uuid}/attach_to_port/
Summary: Attach floating IP to a port
Description: Attach floating IP to port
Path parameters:
  - uuid
Request body: yes

### openstack_floating_ips_detach_from_port
POST /api/openstack-floating-ips/{uuid}/detach_from_port/
Summary: Detach floating IP from port
Path parameters:
  - uuid

### openstack_floating_ips_pull
POST /api/openstack-floating-ips/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openstack_floating_ips_set_erred
POST /api/openstack-floating-ips/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openstack_floating_ips_set_ok
POST /api/openstack-floating-ips/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openstack_floating_ips_unlink
POST /api/openstack-floating-ips/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

### openstack_floating_ips_update_description
POST /api/openstack-floating-ips/{uuid}/update_description/
Summary: Update floating IP description
Description: Update description of the floating IP
Path parameters:
  - uuid
Request body: yes

============================================================
## openstack-health-monitors  (module: waldur_api_client.api.openstack_health_monitors)
============================================================

### openstack_health_monitors_list
GET /api/openstack-health-monitors/
Summary: List health monitors
Description: Get a list of pool health monitors.
Query parameters (8):
  - field
  - load_balancer_uuid — Load balancer UUID
  - name — Name
  - name_exact — Name (exact)
  - pool — Pool URL
  - pool_uuid — Pool UUID
  - state — State
  - tenant_uuid — Tenant UUID

### openstack_health_monitors_count
HEAD /api/openstack-health-monitors/
Summary: List health monitors
Description: Get number of items in the collection matching the request parameters.
Query parameters (7):
  - load_balancer_uuid — Load balancer UUID
  - name — Name
  - name_exact — Name (exact)
  - pool — Pool URL
  - pool_uuid — Pool UUID
  - state — State
  - tenant_uuid — Tenant UUID

### openstack_health_monitors_create
POST /api/openstack-health-monitors/
Summary: Create health monitor
Description: Create a new health monitor for a pool.
Request body: yes

### openstack_health_monitors_retrieve
GET /api/openstack-health-monitors/{uuid}/
Summary: Get health monitor details
Description: Retrieve details of a specific health monitor.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_health_monitors_update
PUT /api/openstack-health-monitors/{uuid}/
Summary: Update health monitor
Description: Update an existing health monitor.
Path parameters:
  - uuid
Request body: yes

### openstack_health_monitors_partial_update
PATCH /api/openstack-health-monitors/{uuid}/
Summary: Partially update health monitor
Description: Update specific fields of a health monitor.
Path parameters:
  - uuid
Request body: yes

### openstack_health_monitors_destroy
DELETE /api/openstack-health-monitors/{uuid}/
Summary: Delete health monitor
Description: Delete a health monitor.
Path parameters:
  - uuid

### openstack_health_monitors_pull
POST /api/openstack-health-monitors/{uuid}/pull/
Summary: Pull health monitor
Description: Synchronize health monitor state from the OpenStack backend. Also pulls the associated pool and load balancer.
Path parameters:
  - uuid

============================================================
## openstack-hypervisor-inventories  (module: waldur_api_client.api.openstack_hypervisor_inventories)
============================================================

### openstack_hypervisor_inventories_list
GET /api/openstack-hypervisor-inventories/
Query parameters (3):
  - hypervisor_uuid
  - resource_class
  - settings_uuid

### openstack_hypervisor_inventories_count
HEAD /api/openstack-hypervisor-inventories/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - hypervisor_uuid
  - resource_class
  - settings_uuid

### openstack_hypervisor_inventories_retrieve
GET /api/openstack-hypervisor-inventories/{uuid}/
Path parameters:
  - uuid

============================================================
## openstack-hypervisors  (module: waldur_api_client.api.openstack_hypervisors)
============================================================

### openstack_hypervisors_list
GET /api/openstack-hypervisors/
Query parameters (8):
  - hypervisor_type
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - state
  - status
  - trait — Trait names with AND logic (comma-separated)

### openstack_hypervisors_count
HEAD /api/openstack-hypervisors/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - hypervisor_type
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - state
  - status
  - trait — Trait names with AND logic (comma-separated)

### openstack_hypervisors_allocation_candidates_retrieve
GET /api/openstack-hypervisors/allocation_candidates/
Summary: Pre-flight allocation candidates
Description: Ask Placement which compute hosts could currently satisfy a request for the given resources (and required traits). Useful as a pre-flight check before placing an order on a fully-booked cloud. Returns 0 candidates when nothing fits, with the same provider_summaries Placement returns for diagnosti...
Query parameters (4):
  - limit — Cap on returned candidates (default 10).
  - required — e.g. HW_CPU_X86_AVX2,STORAGE_DISK_SSD
  - resources (required) — e.g. VCPU:4,MEMORY_MB:8192,DISK_GB:10
  - settings_uuid (required)

### openstack_hypervisors_allocation_candidates_count
HEAD /api/openstack-hypervisors/allocation_candidates/
Summary: Pre-flight allocation candidates
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - limit — Cap on returned candidates (default 10).
  - required — e.g. HW_CPU_X86_AVX2,STORAGE_DISK_SSD
  - resources (required) — e.g. VCPU:4,MEMORY_MB:8192,DISK_GB:10
  - settings_uuid (required)

### openstack_hypervisors_summary_retrieve
GET /api/openstack-hypervisors/summary/
Summary: Get hypervisor summary statistics
Description: Return aggregated vCPU, RAM and disk totals across all hypervisors matching the current filter (e.g. settings_uuid).
Query parameters (1):
  - settings_uuid (required) — UUID of the OpenStack ServiceSettings to aggregate over.

### openstack_hypervisors_summary_count
HEAD /api/openstack-hypervisors/summary/
Summary: Get hypervisor summary statistics
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - settings_uuid (required) — UUID of the OpenStack ServiceSettings to aggregate over.

### openstack_hypervisors_retrieve
GET /api/openstack-hypervisors/{uuid}/
Path parameters:
  - uuid

============================================================
## openstack-images  (module: waldur_api_client.api.openstack_images)
============================================================

### openstack_images_list
GET /api/openstack-images/
Summary: List images
Description: Get a list of available VM instance images.
Query parameters (9):
  - is_rescue_image — Filter to images usable as Nova rescue images.
  - name — Name
  - name_exact — Name (exact)
  - offering_uuid — Offering UUID
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - show_duplicate_names — Show duplicate image names
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_images_count
HEAD /api/openstack-images/
Summary: List images
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - is_rescue_image — Filter to images usable as Nova rescue images.
  - name — Name
  - name_exact — Name (exact)
  - offering_uuid — Offering UUID
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - show_duplicate_names — Show duplicate image names
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_images_usage_stats_retrieve
GET /api/openstack-images/usage_stats/
Summary: Get image usage statistics
Description: Retrieve usage statistics for VM instance images, showing running and created instance counts for each image.

### openstack_images_usage_stats_count
HEAD /api/openstack-images/usage_stats/
Summary: Get image usage statistics
Description: Get number of items in the collection matching the request parameters.

### openstack_images_retrieve
GET /api/openstack-images/{uuid}/
Summary: Get image details
Description: Retrieve details of a specific VM instance image.
Path parameters:
  - uuid

============================================================
## openstack-instance-availability-zones  (module: waldur_api_client.api.openstack_instance_availability_zones)
============================================================

### openstack_instance_availability_zones_list
GET /api/openstack-instance-availability-zones/
Summary: List instance availability zones
Description: Get a list of instance availability zones.
Query parameters (6):
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_instance_availability_zones_count
HEAD /api/openstack-instance-availability-zones/
Summary: List instance availability zones
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_instance_availability_zones_retrieve
GET /api/openstack-instance-availability-zones/{uuid}/
Summary: Get instance availability zone details
Description: Retrieve details of a specific instance availability zone.
Path parameters:
  - uuid

============================================================
## openstack-instances  (module: waldur_api_client.api.openstack_instances)
============================================================

### openstack_instances_list
GET /api/openstack-instances/
Summary: List instances
Description: Get a list of VM instances.
Query parameters (25):
  - attach_volume_uuid — Filter for attachment to volume UUID
  - availability_zone_name — Availability zone name
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering. Sort by start time.
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - query — Search by name, internal IP, or external IP
  - runtime_state
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_instances_count
HEAD /api/openstack-instances/
Summary: List instances
Description: Get number of items in the collection matching the request parameters.
Query parameters (24):
  - attach_volume_uuid — Filter for attachment to volume UUID
  - availability_zone_name — Availability zone name
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering. Sort by start time.
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - query — Search by name, internal IP, or external IP
  - runtime_state
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_instances_retrieve
GET /api/openstack-instances/{uuid}/
Summary: Get instance details
Description: Retrieve details of a specific VM instance.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_instances_update
PUT /api/openstack-instances/{uuid}/
Summary: Update instance
Description: Update an existing VM instance.
Path parameters:
  - uuid
Request body: yes

### openstack_instances_partial_update
PATCH /api/openstack-instances/{uuid}/
Summary: Partially update instance
Description: Update specific fields of a VM instance.
Path parameters:
  - uuid
Request body: yes

### openstack_instances_backup
POST /api/openstack-instances/{uuid}/backup/
Summary: Create instance backup
Description: Create backup from instance
Path parameters:
  - uuid
Request body: yes

### openstack_instances_change_flavor
POST /api/openstack-instances/{uuid}/change_flavor/
Summary: Change instance flavor
Description: Change flavor of the instance
Path parameters:
  - uuid
Request body: yes

### openstack_instances_console_retrieve
GET /api/openstack-instances/{uuid}/console/
Summary: Get console URL
Description: Get console url for the instance
Path parameters:
  - uuid

### openstack_instances_console_log_retrieve
GET /api/openstack-instances/{uuid}/console_log/
Summary: Get console log
Description: Get console log for the instance
Path parameters:
  - uuid
Query parameters (1):
  - length

### openstack_instances_diagnose_connectivity
POST /api/openstack-instances/{uuid}/diagnose_connectivity/
Summary: Diagnose connectivity
Description: Walks the wiring that connects this instance to the requested target (default 'external') and returns a per-check report computed from Waldur's already-pulled state — no live OpenStack call. Use to triage 'VM can't reach the internet' or 'VIP doesn't work' tickets in one click.
Path parameters:
  - uuid
Request body: yes

### openstack_instances_floating_ips_list
GET /api/openstack-instances/{uuid}/floating_ips/
Summary: List instance floating IPs
Description: Get a list of instance floating IPs
Path parameters:
  - uuid

### openstack_instances_placement_allocations_list
GET /api/openstack-instances/{uuid}/placement_allocations/
Summary: Get Placement allocations for the instance
Description: Return what the OpenStack Placement service records as currently allocated to this instance, broken down by resource provider. Useful for diagnostics — especially for non-classic resources (VGPU, PCI_DEVICE, custom classes) that the flavor alone does not describe. Returns an empty list when Place...
Path parameters:
  - uuid

### openstack_instances_ports_list
GET /api/openstack-instances/{uuid}/ports/
Summary: List instance ports
Description: Get a list of instance ports
Path parameters:
  - uuid

### openstack_instances_pull
POST /api/openstack-instances/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openstack_instances_rescue
POST /api/openstack-instances/{uuid}/rescue/
Summary: Rescue instance
Description: Boot the instance from a separate rescue image while keeping the original disk attached. Volume-backed instances require an explicit rescue_image with hw_rescue_device or hw_rescue_bus set.
Path parameters:
  - uuid
Request body: yes

### openstack_instances_restart
POST /api/openstack-instances/{uuid}/restart/
Summary: Restart instance
Description: Restart the instance
Path parameters:
  - uuid

### openstack_instances_set_erred
POST /api/openstack-instances/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openstack_instances_set_ok
POST /api/openstack-instances/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openstack_instances_start
POST /api/openstack-instances/{uuid}/start/
Summary: Start instance
Description: Start the instance
Path parameters:
  - uuid

### openstack_instances_stop
POST /api/openstack-instances/{uuid}/stop/
Summary: Stop instance
Description: Stop the instance
Path parameters:
  - uuid

### openstack_instances_unlink
POST /api/openstack-instances/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

### openstack_instances_unrescue
POST /api/openstack-instances/{uuid}/unrescue/
Summary: Unrescue instance
Description: Restore the instance from rescue mode.
Path parameters:
  - uuid

### openstack_instances_update_allowed_address_pairs
POST /api/openstack-instances/{uuid}/update_allowed_address_pairs/
Summary: Update instance allowed address pairs
Description: Update allowed address pairs of the instance
Path parameters:
  - uuid
Request body: yes

### openstack_instances_update_floating_ips
POST /api/openstack-instances/{uuid}/update_floating_ips/
Summary: Update instance floating IPs
Description: Update floating IPs of the instance
Path parameters:
  - uuid
Request body: yes

### openstack_instances_update_ports
POST /api/openstack-instances/{uuid}/update_ports/
Summary: Update instance ports
Description: Update ports of the instance
Path parameters:
  - uuid
Request body: yes

### openstack_instances_update_security_groups
POST /api/openstack-instances/{uuid}/update_security_groups/
Summary: Update instance security groups
Description: Update security groups of the instance
Path parameters:
  - uuid
Request body: yes

============================================================
## openstack-listeners  (module: waldur_api_client.api.openstack_listeners)
============================================================

### openstack_listeners_list
GET /api/openstack-listeners/
Summary: List listeners
Description: Get a list of load balancer listeners.
Query parameters (7):
  - field
  - load_balancer — Load balancer URL
  - load_balancer_uuid — Load balancer UUID
  - name — Name
  - name_exact — Name (exact)
  - state — State
  - tenant_uuid — Tenant UUID

### openstack_listeners_count
HEAD /api/openstack-listeners/
Summary: List listeners
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - load_balancer — Load balancer URL
  - load_balancer_uuid — Load balancer UUID
  - name — Name
  - name_exact — Name (exact)
  - state — State
  - tenant_uuid — Tenant UUID

### openstack_listeners_create
POST /api/openstack-listeners/
Summary: Create listener
Description: Create a new listener for a load balancer.
Request body: yes

### openstack_listeners_retrieve
GET /api/openstack-listeners/{uuid}/
Summary: Get listener details
Description: Retrieve details of a specific listener.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_listeners_update
PUT /api/openstack-listeners/{uuid}/
Summary: Update listener
Description: Update an existing listener.
Path parameters:
  - uuid
Request body: yes

### openstack_listeners_partial_update
PATCH /api/openstack-listeners/{uuid}/
Summary: Partially update listener
Description: Update specific fields of a listener.
Path parameters:
  - uuid
Request body: yes

### openstack_listeners_destroy
DELETE /api/openstack-listeners/{uuid}/
Summary: Delete listener
Description: Delete a listener.
Path parameters:
  - uuid

### openstack_listeners_pull
POST /api/openstack-listeners/{uuid}/pull/
Summary: Pull listener
Description: Synchronize listener state from the OpenStack backend. Also pulls pools of the load balancer and the load balancer itself.
Path parameters:
  - uuid

============================================================
## openstack-loadbalancers  (module: waldur_api_client.api.openstack_loadbalancers)
============================================================

### openstack_loadbalancers_list
GET /api/openstack-loadbalancers/
Summary: List load balancers
Description: Get a list of load balancers.
Query parameters (6):
  - field
  - name — Name
  - name_exact — Name (exact)
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_loadbalancers_count
HEAD /api/openstack-loadbalancers/
Summary: List load balancers
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - name — Name
  - name_exact — Name (exact)
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_loadbalancers_create
POST /api/openstack-loadbalancers/
Summary: Create load balancer
Description: Create a new load balancer.
Request body: yes

### openstack_loadbalancers_retrieve
GET /api/openstack-loadbalancers/{uuid}/
Summary: Get load balancer details
Description: Retrieve details of a specific load balancer.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_loadbalancers_update
PUT /api/openstack-loadbalancers/{uuid}/
Summary: Update load balancer
Description: Update an existing load balancer.
Path parameters:
  - uuid
Request body: yes

### openstack_loadbalancers_partial_update
PATCH /api/openstack-loadbalancers/{uuid}/
Summary: Partially update load balancer
Description: Update specific fields of a load balancer.
Path parameters:
  - uuid
Request body: yes

### openstack_loadbalancers_destroy
DELETE /api/openstack-loadbalancers/{uuid}/
Summary: Delete load balancer
Description: Delete a load balancer.
Path parameters:
  - uuid

### openstack_loadbalancers_attach_floating_ip
POST /api/openstack-loadbalancers/{uuid}/attach_floating_ip/
Summary: Attach floating IP to VIP
Description: Attach a floating IP to the load balancer VIP port.
Path parameters:
  - uuid
Request body: yes

### openstack_loadbalancers_detach_floating_ip
POST /api/openstack-loadbalancers/{uuid}/detach_floating_ip/
Summary: Detach floating IP from VIP
Description: Detach floating IP from the load balancer VIP port.
Path parameters:
  - uuid

### openstack_loadbalancers_pull
POST /api/openstack-loadbalancers/{uuid}/pull/
Summary: Pull load balancer
Description: Synchronize load balancer state from the OpenStack backend.
Path parameters:
  - uuid

### openstack_loadbalancers_set_security_groups
POST /api/openstack-loadbalancers/{uuid}/set_security_groups/
Summary: Set security groups on VIP port
Description: Set security groups on the load balancer VIP port to control access.
Path parameters:
  - uuid
Request body: yes

### openstack_loadbalancers_unlink
POST /api/openstack-loadbalancers/{uuid}/unlink/
Summary: Unlink load balancer
Description: Delete the load balancer from the Waldur database without scheduling operations on the OpenStack backend and without checking resource state. Staff-only; intended for cleaning up records stuck in transitional states.
Path parameters:
  - uuid

============================================================
## openstack-marketplace-tenants  (module: waldur_api_client.api.openstack_marketplace_tenants)
============================================================

### openstack_marketplace_tenants_list
GET /api/openstack-marketplace-tenants/
Query parameters (17):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### openstack_marketplace_tenants_count
HEAD /api/openstack-marketplace-tenants/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (17):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### openstack_marketplace_tenants_retrieve
GET /api/openstack-marketplace-tenants/{uuid}/
Path parameters:
  - uuid

### openstack_marketplace_tenants_create_image
POST /api/openstack-marketplace-tenants/{uuid}/create_image/
Path parameters:
  - uuid
Request body: yes

### openstack_marketplace_tenants_upload_image_data
POST /api/openstack-marketplace-tenants/{uuid}/upload_image_data/{image_id}/
Path parameters:
  - image_id
  - uuid
Request body: yes

============================================================
## openstack-migrations  (module: waldur_api_client.api.openstack_migrations)
============================================================

### openstack_migrations_list
GET /api/openstack-migrations/
Query parameters (2):
  - dst_resource_uuid
  - src_resource_uuid

### openstack_migrations_count
HEAD /api/openstack-migrations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - dst_resource_uuid
  - src_resource_uuid

### openstack_migrations_create
POST /api/openstack-migrations/
Request body: yes

### openstack_migrations_retrieve
GET /api/openstack-migrations/{uuid}/
Path parameters:
  - uuid

### openstack_migrations_update
PUT /api/openstack-migrations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### openstack_migrations_partial_update
PATCH /api/openstack-migrations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### openstack_migrations_destroy
DELETE /api/openstack-migrations/{uuid}/
Path parameters:
  - uuid

============================================================
## openstack-network-rbac-policies  (module: waldur_api_client.api.openstack_network_rbac_policies)
============================================================

### openstack_network_rbac_policies_list
GET /api/openstack-network-rbac-policies/
Summary: List network RBAC policies
Description: Get a list of network RBAC policies.
Query parameters (8):
  - direction — Direction relative to the requesting user
  - network — Network URL
  - network_uuid — Network UUID
  - policy_type — Type of access granted - either shared access or external network access
  - target_tenant — Target tenant URL
  - target_tenant_uuid — Target tenant UUID
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_network_rbac_policies_count
HEAD /api/openstack-network-rbac-policies/
Summary: List network RBAC policies
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - direction — Direction relative to the requesting user
  - network — Network URL
  - network_uuid — Network UUID
  - policy_type — Type of access granted - either shared access or external network access
  - target_tenant — Target tenant URL
  - target_tenant_uuid — Target tenant UUID
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_network_rbac_policies_create
POST /api/openstack-network-rbac-policies/
Summary: Create RBAC policy
Description: Create RBAC policy for the network
Request body: yes

### openstack_network_rbac_policies_retrieve
GET /api/openstack-network-rbac-policies/{uuid}/
Summary: Get network RBAC policy details
Description: Retrieve details of a specific network RBAC policy.
Path parameters:
  - uuid

### openstack_network_rbac_policies_update
PUT /api/openstack-network-rbac-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### openstack_network_rbac_policies_partial_update
PATCH /api/openstack-network-rbac-policies/{uuid}/
Path parameters:
  - uuid
Request body: yes

### openstack_network_rbac_policies_destroy
DELETE /api/openstack-network-rbac-policies/{uuid}/
Summary: Delete RBAC policy
Description: Delete RBAC policy for the network
Path parameters:
  - uuid

============================================================
## openstack-networks  (module: waldur_api_client.api.openstack_networks)
============================================================

### openstack_networks_list
GET /api/openstack-networks/
Summary: List networks
Description: Get a list of networks.
Query parameters (24):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - direct_only — Direct only
  - external_ip — External IP
  - field
  - is_external
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - rbac_only — RBAC only
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID
  - type

### openstack_networks_count
HEAD /api/openstack-networks/
Summary: List networks
Description: Get number of items in the collection matching the request parameters.
Query parameters (23):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - direct_only — Direct only
  - external_ip — External IP
  - is_external
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - rbac_only — RBAC only
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID
  - type

### openstack_networks_retrieve
GET /api/openstack-networks/{uuid}/
Summary: Get network details
Description: Retrieve details of a specific network.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_networks_update
PUT /api/openstack-networks/{uuid}/
Summary: Update network
Description: Update an existing network.
Path parameters:
  - uuid
Request body: yes

### openstack_networks_partial_update
PATCH /api/openstack-networks/{uuid}/
Summary: Partially update network
Description: Update specific fields of a network.
Path parameters:
  - uuid
Request body: yes

### openstack_networks_destroy
DELETE /api/openstack-networks/{uuid}/
Summary: Delete network
Description: Delete a network.
Path parameters:
  - uuid

### openstack_networks_create_subnet
POST /api/openstack-networks/{uuid}/create_subnet/
Summary: Create subnet
Description: Create a new subnet within the network.
Path parameters:
  - uuid
Request body: yes

### openstack_networks_pull
POST /api/openstack-networks/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openstack_networks_rbac_policy_create
POST /api/openstack-networks/{uuid}/rbac_policy_create/
Summary: Create RBAC policy
Description: Create RBAC policy for the network. DEPRECATED: please use the dedicated /api/openstack-network-rbac-policies/ endpoint.
Path parameters:
  - uuid
Request body: yes

### openstack_networks_rbac_policy_delete_destroy
DELETE /api/openstack-networks/{uuid}/rbac_policy_delete/{rbac_policy_uuid}/
Summary: Delete RBAC policy
Description: Delete RBAC policy for the network. DEPRECATED: please use the dedicated /api/openstack-network-rbac-policies/ endpoint.
Path parameters:
  - rbac_policy_uuid — UUID of the RBAC policy to delete
  - uuid

### openstack_networks_set_erred
POST /api/openstack-networks/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openstack_networks_set_mtu
POST /api/openstack-networks/{uuid}/set_mtu/
Summary: Set network MTU
Description: Update the Maximum Transmission Unit (MTU) for the network.
Path parameters:
  - uuid
Request body: yes

### openstack_networks_set_ok
POST /api/openstack-networks/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openstack_networks_unlink
POST /api/openstack-networks/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## openstack-pool-members  (module: waldur_api_client.api.openstack_pool_members)
============================================================

### openstack_pool_members_list
GET /api/openstack-pool-members/
Summary: List pool members
Description: Get a list of pool members.
Query parameters (8):
  - field
  - load_balancer_uuid — Load balancer UUID
  - name — Name
  - name_exact — Name (exact)
  - pool — Pool URL
  - pool_uuid — Pool UUID
  - state — State
  - tenant_uuid — Tenant UUID

### openstack_pool_members_count
HEAD /api/openstack-pool-members/
Summary: List pool members
Description: Get number of items in the collection matching the request parameters.
Query parameters (7):
  - load_balancer_uuid — Load balancer UUID
  - name — Name
  - name_exact — Name (exact)
  - pool — Pool URL
  - pool_uuid — Pool UUID
  - state — State
  - tenant_uuid — Tenant UUID

### openstack_pool_members_create
POST /api/openstack-pool-members/
Summary: Create pool member
Description: Create a new member for a pool.
Request body: yes

### openstack_pool_members_retrieve
GET /api/openstack-pool-members/{uuid}/
Summary: Get pool member details
Description: Retrieve details of a specific pool member.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_pool_members_update
PUT /api/openstack-pool-members/{uuid}/
Summary: Update pool member
Description: Update an existing pool member.
Path parameters:
  - uuid
Request body: yes

### openstack_pool_members_partial_update
PATCH /api/openstack-pool-members/{uuid}/
Summary: Partially update pool member
Description: Update specific fields of a pool member.
Path parameters:
  - uuid
Request body: yes

### openstack_pool_members_destroy
DELETE /api/openstack-pool-members/{uuid}/
Summary: Delete pool member
Description: Delete a pool member.
Path parameters:
  - uuid

### openstack_pool_members_pull
POST /api/openstack-pool-members/{uuid}/pull/
Summary: Pull pool member
Description: Synchronize pool member state from the OpenStack backend. Also pulls the associated pool and load balancer.
Path parameters:
  - uuid

============================================================
## openstack-pools  (module: waldur_api_client.api.openstack_pools)
============================================================

### openstack_pools_list
GET /api/openstack-pools/
Summary: List pools
Description: Get a list of load balancer pools.
Query parameters (7):
  - field
  - load_balancer — Load balancer URL
  - load_balancer_uuid — Load balancer UUID
  - name — Name
  - name_exact — Name (exact)
  - state — State
  - tenant_uuid — Tenant UUID

### openstack_pools_count
HEAD /api/openstack-pools/
Summary: List pools
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - load_balancer — Load balancer URL
  - load_balancer_uuid — Load balancer UUID
  - name — Name
  - name_exact — Name (exact)
  - state — State
  - tenant_uuid — Tenant UUID

### openstack_pools_create
POST /api/openstack-pools/
Summary: Create pool
Description: Create a new pool for a load balancer.
Request body: yes

### openstack_pools_retrieve
GET /api/openstack-pools/{uuid}/
Summary: Get pool details
Description: Retrieve details of a specific pool.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_pools_update
PUT /api/openstack-pools/{uuid}/
Summary: Update pool
Description: Update an existing pool.
Path parameters:
  - uuid
Request body: yes

### openstack_pools_partial_update
PATCH /api/openstack-pools/{uuid}/
Summary: Partially update pool
Description: Update specific fields of a pool.
Path parameters:
  - uuid
Request body: yes

### openstack_pools_destroy
DELETE /api/openstack-pools/{uuid}/
Summary: Delete pool
Description: Delete a pool.
Path parameters:
  - uuid

### openstack_pools_pull
POST /api/openstack-pools/{uuid}/pull/
Summary: Pull pool
Description: Synchronize pool state from the OpenStack backend. Also pulls the associated load balancer.
Path parameters:
  - uuid

============================================================
## openstack-ports  (module: waldur_api_client.api.openstack_ports)
============================================================

### openstack_ports_list
GET /api/openstack-ports/
Summary: List ports
Description: Get a list of network ports.
Query parameters (18):
  - admin_state_up
  - backend_id
  - device_id
  - device_owner
  - exclude_subnet_uuids — Exclude Subnet UUIDs (comma-separated)
  - field
  - fixed_ips — Search by fixed IP
  - has_device_owner — Has device owner
  - mac_address
  - name — Name
  - name_exact — Name (exact)
  - network_name — Search by network name
  - network_uuid — Search by network UUID
  - o — Ordering
  - query — Search by name, MAC address or backend ID
  - status
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_ports_count
HEAD /api/openstack-ports/
Summary: List ports
Description: Get number of items in the collection matching the request parameters.
Query parameters (17):
  - admin_state_up
  - backend_id
  - device_id
  - device_owner
  - exclude_subnet_uuids — Exclude Subnet UUIDs (comma-separated)
  - fixed_ips — Search by fixed IP
  - has_device_owner — Has device owner
  - mac_address
  - name — Name
  - name_exact — Name (exact)
  - network_name — Search by network name
  - network_uuid — Search by network UUID
  - o — Ordering
  - query — Search by name, MAC address or backend ID
  - status
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_ports_create
POST /api/openstack-ports/
Summary: Create port
Description: Create a new network port.
Request body: yes

### openstack_ports_retrieve
GET /api/openstack-ports/{uuid}/
Summary: Get port details
Description: Retrieve details of a specific network port.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_ports_update
PUT /api/openstack-ports/{uuid}/
Summary: Update port
Description: Update an existing network port.
Path parameters:
  - uuid
Request body: yes

### openstack_ports_partial_update
PATCH /api/openstack-ports/{uuid}/
Summary: Partially update port
Description: Update specific fields of a network port.
Path parameters:
  - uuid
Request body: yes

### openstack_ports_destroy
DELETE /api/openstack-ports/{uuid}/
Summary: Delete port
Description: Delete a network port.
Path parameters:
  - uuid

### openstack_ports_disable_port
POST /api/openstack-ports/{uuid}/disable_port/
Summary: Disable port
Description: Disable port.
Path parameters:
  - uuid

### openstack_ports_disable_port_security
POST /api/openstack-ports/{uuid}/disable_port_security/
Summary: Disable port security
Description: Disable port security for the port
Path parameters:
  - uuid

### openstack_ports_enable_port
POST /api/openstack-ports/{uuid}/enable_port/
Summary: Enable port
Description: Enable port.
Path parameters:
  - uuid

### openstack_ports_enable_port_security
POST /api/openstack-ports/{uuid}/enable_port_security/
Summary: Enable port security
Description: Enable port security for the port
Path parameters:
  - uuid

### openstack_ports_pull
POST /api/openstack-ports/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openstack_ports_set_allowed_address_pairs
POST /api/openstack-ports/{uuid}/set_allowed_address_pairs/
Summary: Set allowed address pairs
Description: Replace the Port's allowed_address_pairs list. Cluster-VIP workloads (keepalived, MetalLB, OpenShift ingress, OVN router) need ports to permit additional IP/MAC pairs beyond their fixed IPs. Values are validated and pushed to Neutron.
Path parameters:
  - uuid
Request body: yes

### openstack_ports_set_erred
POST /api/openstack-ports/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openstack_ports_set_ok
POST /api/openstack-ports/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openstack_ports_unlink
POST /api/openstack-ports/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

### openstack_ports_update_port_ip
POST /api/openstack-ports/{uuid}/update_port_ip/
Summary: Update port IP address
Description: Update port IP address.
Path parameters:
  - uuid
Request body: yes

### openstack_ports_update_security_groups
POST /api/openstack-ports/{uuid}/update_security_groups/
Summary: Update port security groups
Description: Update security groups of the port
Path parameters:
  - uuid
Request body: yes

============================================================
## openstack-routers  (module: waldur_api_client.api.openstack_routers)
============================================================

### openstack_routers_list
GET /api/openstack-routers/
Summary: List routers
Description: Get a list of routers.
Query parameters (6):
  - field
  - name — Name
  - name_exact — Name (exact)
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_routers_count
HEAD /api/openstack-routers/
Summary: List routers
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - name — Name
  - name_exact — Name (exact)
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_routers_create
POST /api/openstack-routers/
Summary: Create router
Description: Create a new router.
Request body: yes

### openstack_routers_retrieve
GET /api/openstack-routers/{uuid}/
Summary: Get router details
Description: Retrieve details of a specific router.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_routers_destroy
DELETE /api/openstack-routers/{uuid}/
Summary: Delete router
Description: Delete a router.
Path parameters:
  - uuid

### openstack_routers_add_router_interface
POST /api/openstack-routers/{uuid}/add_router_interface/
Summary: Add router interface
Description: Add interface to router. Either subnet or port must be provided.
Path parameters:
  - uuid
Request body: yes

### openstack_routers_available_external_networks_list
GET /api/openstack-routers/{uuid}/available_external_networks/
Summary: List available external networks
Description: Returns a merged list of external networks available for this router's tenant, from both global external networks and RBAC-exposed networks.
Path parameters:
  - uuid
Query parameters (5):
  - name — Name
  - name_exact — Name (exact)
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_routers_effective_routes_retrieve
GET /api/openstack-routers/{uuid}/effective_routes/
Summary: Effective routes for this router
Description: Compose the router's routing table from three sources: the default route inherited from the external gateway subnet, the on-link routes implied by each attached interface, and the user-set static routes. SNAT state is reported alongside.
Path parameters:
  - uuid

### openstack_routers_remove_external_gateway
POST /api/openstack-routers/{uuid}/remove_external_gateway/
Summary: Remove external gateway
Description: Remove the external gateway from this router.
Path parameters:
  - uuid

### openstack_routers_remove_router_interface
POST /api/openstack-routers/{uuid}/remove_router_interface/
Summary: Remove router interface
Description: Remove interface from router. Either subnet or port must be provided.
Path parameters:
  - uuid
Request body: yes

### openstack_routers_set_erred
POST /api/openstack-routers/{uuid}/set_erred/
Summary: Mark router as ERRED
Description: Manually transition the router to ERRED state. This is useful for routers stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openstack_routers_set_external_gateway
POST /api/openstack-routers/{uuid}/set_external_gateway/
Summary: Set external gateway
Description: Set an external network as the gateway for this router. Advanced options (SNAT control, fixed IPs) require additional permissions.
Path parameters:
  - uuid
Request body: yes

### openstack_routers_set_ok
POST /api/openstack-routers/{uuid}/set_ok/
Summary: Mark router as OK
Description: Manually transition the router to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openstack_routers_set_routes
POST /api/openstack-routers/{uuid}/set_routes/
Summary: Set static routes
Description: Define or overwrite the static routes for the router.
Path parameters:
  - uuid
Request body: yes

============================================================
## openstack-security-groups  (module: waldur_api_client.api.openstack_security_groups)
============================================================

### openstack_security_groups_list
GET /api/openstack-security-groups/
Summary: List security groups
Description: Get a list of security groups.
Query parameters (21):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - query — Search by name or description
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_security_groups_count
HEAD /api/openstack-security-groups/
Summary: List security groups
Description: Get number of items in the collection matching the request parameters.
Query parameters (20):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - query — Search by name or description
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_security_groups_retrieve
GET /api/openstack-security-groups/{uuid}/
Summary: Get security group details
Description: Retrieve details of a specific security group.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_security_groups_update
PUT /api/openstack-security-groups/{uuid}/
Path parameters:
  - uuid
Request body: yes

### openstack_security_groups_partial_update
PATCH /api/openstack-security-groups/{uuid}/
Summary: Partially update security group
Description: Update specific fields of a security group.
Path parameters:
  - uuid
Request body: yes

### openstack_security_groups_destroy
DELETE /api/openstack-security-groups/{uuid}/
Summary: Delete security group
Description: Delete a security group.
Path parameters:
  - uuid

### openstack_security_groups_pull
POST /api/openstack-security-groups/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openstack_security_groups_set_erred
POST /api/openstack-security-groups/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openstack_security_groups_set_ok
POST /api/openstack-security-groups/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openstack_security_groups_set_rules
POST /api/openstack-security-groups/{uuid}/set_rules/
Summary: Set security group rules
Description: Update the rules for a specific security group. This overwrites all existing rules.
Path parameters:
  - uuid
Request body: yes

### openstack_security_groups_unlink
POST /api/openstack-security-groups/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## openstack-server-groups  (module: waldur_api_client.api.openstack_server_groups)
============================================================

### openstack_server_groups_list
GET /api/openstack-server-groups/
Summary: List server groups
Description: Get a list of server groups.
Query parameters (20):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_server_groups_count
HEAD /api/openstack-server-groups/
Summary: List server groups
Description: Get number of items in the collection matching the request parameters.
Query parameters (19):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_server_groups_create
POST /api/openstack-server-groups/
Request body: yes

### openstack_server_groups_retrieve
GET /api/openstack-server-groups/{uuid}/
Summary: Get server group details
Description: Retrieve details of a specific server group.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_server_groups_destroy
DELETE /api/openstack-server-groups/{uuid}/
Summary: Delete server group
Description: Delete a server group.
Path parameters:
  - uuid

### openstack_server_groups_pull
POST /api/openstack-server-groups/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openstack_server_groups_set_erred
POST /api/openstack-server-groups/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openstack_server_groups_set_ok
POST /api/openstack-server-groups/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openstack_server_groups_unlink
POST /api/openstack-server-groups/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## openstack-snapshots  (module: waldur_api_client.api.openstack_snapshots)
============================================================

### openstack_snapshots_list
GET /api/openstack-snapshots/
Summary: List snapshots
Description: Get a list of snapshots.
Query parameters (25):
  - backend_id — Backend ID
  - backup — Backup URL
  - backup_uuid — Backup UUID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - runtime_state
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - source_volume — Source volume URL
  - source_volume_uuid — Source volume UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_snapshots_count
HEAD /api/openstack-snapshots/
Summary: List snapshots
Description: Get number of items in the collection matching the request parameters.
Query parameters (24):
  - backend_id — Backend ID
  - backup — Backup URL
  - backup_uuid — Backup UUID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - runtime_state
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - source_volume — Source volume URL
  - source_volume_uuid — Source volume UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_snapshots_retrieve
GET /api/openstack-snapshots/{uuid}/
Summary: Get snapshot details
Description: Retrieve details of a specific snapshot.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_snapshots_update
PUT /api/openstack-snapshots/{uuid}/
Summary: Update snapshot
Description: Update an existing snapshot.
Path parameters:
  - uuid
Request body: yes

### openstack_snapshots_partial_update
PATCH /api/openstack-snapshots/{uuid}/
Summary: Partially update snapshot
Description: Update specific fields of a snapshot.
Path parameters:
  - uuid
Request body: yes

### openstack_snapshots_destroy
DELETE /api/openstack-snapshots/{uuid}/
Summary: Delete snapshot
Description: Delete a snapshot.
Path parameters:
  - uuid

### openstack_snapshots_pull
POST /api/openstack-snapshots/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openstack_snapshots_restorations_list
GET /api/openstack-snapshots/{uuid}/restorations/
Summary: List snapshot restorations
Description: Get a list of snapshot restorations
Path parameters:
  - uuid

### openstack_snapshots_restore
POST /api/openstack-snapshots/{uuid}/restore/
Summary: Restore volume from snapshot
Path parameters:
  - uuid
Request body: yes

### openstack_snapshots_set_erred
POST /api/openstack-snapshots/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openstack_snapshots_set_ok
POST /api/openstack-snapshots/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openstack_snapshots_unlink
POST /api/openstack-snapshots/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## openstack-subnets  (module: waldur_api_client.api.openstack_subnets)
============================================================

### openstack_subnets_list
GET /api/openstack-subnets/
Summary: List subnets
Description: Get a list of subnets.
Query parameters (26):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - direct_only — Direct only
  - enable_dhcp
  - external_ip — External IP
  - field
  - ip_version
  - name — Name
  - name_exact — Name (exact)
  - network — Network URL
  - network_uuid — Network UUID
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - rbac_only — RBAC only
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_subnets_count
HEAD /api/openstack-subnets/
Summary: List subnets
Description: Get number of items in the collection matching the request parameters.
Query parameters (25):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - direct_only — Direct only
  - enable_dhcp
  - external_ip — External IP
  - ip_version
  - name — Name
  - name_exact — Name (exact)
  - network — Network URL
  - network_uuid — Network UUID
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - rbac_only — RBAC only
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_subnets_retrieve
GET /api/openstack-subnets/{uuid}/
Summary: Get subnet details
Description: Retrieve details of a specific subnet.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_subnets_update
PUT /api/openstack-subnets/{uuid}/
Summary: Update subnet
Description: Update an existing subnet.
Path parameters:
  - uuid
Request body: yes

### openstack_subnets_partial_update
PATCH /api/openstack-subnets/{uuid}/
Summary: Partially update subnet
Description: Update specific fields of a subnet.
Path parameters:
  - uuid
Request body: yes

### openstack_subnets_destroy
DELETE /api/openstack-subnets/{uuid}/
Summary: Delete subnet
Description: Delete a subnet.
Path parameters:
  - uuid

### openstack_subnets_connect
POST /api/openstack-subnets/{uuid}/connect/
Summary: Connect subnet to router
Description: Connect the subnet to the default tenant router.
Path parameters:
  - uuid

### openstack_subnets_disconnect
POST /api/openstack-subnets/{uuid}/disconnect/
Summary: Disconnect subnet from router
Description: Disconnect the subnet from the default tenant router.
Path parameters:
  - uuid

### openstack_subnets_pull
POST /api/openstack-subnets/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openstack_subnets_set_erred
POST /api/openstack-subnets/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openstack_subnets_set_ok
POST /api/openstack-subnets/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openstack_subnets_unlink
POST /api/openstack-subnets/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## openstack-tenants  (module: waldur_api_client.api.openstack_tenants)
============================================================

### openstack_tenants_list
GET /api/openstack-tenants/
Summary: List tenants
Description: Get a list of OpenStack tenants.
Query parameters (18):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### openstack_tenants_count
HEAD /api/openstack-tenants/
Summary: List tenants
Description: Get number of items in the collection matching the request parameters.
Query parameters (17):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### openstack_tenants_retrieve
GET /api/openstack-tenants/{uuid}/
Summary: Get tenant details
Description: Retrieve details of a specific OpenStack tenant.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_tenants_update
PUT /api/openstack-tenants/{uuid}/
Summary: Update tenant
Description: Update an existing OpenStack tenant.
Path parameters:
  - uuid
Request body: yes

### openstack_tenants_partial_update
PATCH /api/openstack-tenants/{uuid}/
Summary: Partially update tenant
Description: Update specific fields of an OpenStack tenant.
Path parameters:
  - uuid
Request body: yes

### openstack_tenants_backend_instances_list
GET /api/openstack-tenants/{uuid}/backend_instances/
Summary: List backend instances
Description: Return a list of volumes from backend
Path parameters:
  - uuid
Query parameters (17):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### openstack_tenants_backend_volumes_list
GET /api/openstack-tenants/{uuid}/backend_volumes/
Summary: List backend volumes
Description: Return a list of volumes from backend
Path parameters:
  - uuid
Query parameters (17):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### openstack_tenants_change_password
POST /api/openstack-tenants/{uuid}/change_password/
Summary: Change tenant user password
Description: Change password for tenant user
Path parameters:
  - uuid
Request body: yes

### openstack_tenants_create_floating_ip
POST /api/openstack-tenants/{uuid}/create_floating_ip/
Summary: Create floating IP for tenant
Path parameters:
  - uuid
Request body: yes

### openstack_tenants_create_network
POST /api/openstack-tenants/{uuid}/create_network/
Summary: Create network for tenant
Path parameters:
  - uuid
Request body: yes

### openstack_tenants_create_security_group
POST /api/openstack-tenants/{uuid}/create_security_group/
Summary: Create security group
Description: Create a security group for the tenant.
Path parameters:
  - uuid
Request body: yes

### openstack_tenants_create_server_group
POST /api/openstack-tenants/{uuid}/create_server_group/
Summary: Create server group
Description: Create a new server group for the tenant.
Path parameters:
  - uuid
Request body: yes

### openstack_tenants_pull
POST /api/openstack-tenants/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openstack_tenants_pull_floating_ips
POST /api/openstack-tenants/{uuid}/pull_floating_ips/
Summary: Pull floating IPs
Description: Trigger job to pull floating IPs from remote VPC
Path parameters:
  - uuid

### openstack_tenants_pull_quotas
POST /api/openstack-tenants/{uuid}/pull_quotas/
Summary: Pull tenant quotas
Description: It triggers celery job to pull quotas from remote VPC
Path parameters:
  - uuid

### openstack_tenants_pull_security_groups
POST /api/openstack-tenants/{uuid}/pull_security_groups/
Summary: Pull security groups
Description: Trigger job to pull security groups from remote VPC
Path parameters:
  - uuid

### openstack_tenants_pull_server_groups
POST /api/openstack-tenants/{uuid}/pull_server_groups/
Summary: Pull server groups
Description: Trigger job to pull server groups from remote VPC
Path parameters:
  - uuid

### openstack_tenants_push_security_groups
POST /api/openstack-tenants/{uuid}/push_security_groups/
Summary: Batch update security groups for a tenant.
Description: * Security groups with UUIDs are updated.
        * Security groups without UUIDs are created.
        * Security groups existing in the tenant but not present in the request are deleted.
        * Rules for created/updated security groups are replaced.

        To reference a remote group within...
Path parameters:
  - uuid
Request body: yes

### openstack_tenants_set_erred
POST /api/openstack-tenants/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openstack_tenants_set_ok
POST /api/openstack-tenants/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openstack_tenants_set_quotas
POST /api/openstack-tenants/{uuid}/set_quotas/
Summary: Set tenant quotas
Description: A quota can be set for a particular tenant. Only staff users and service provider owners/managers can do that.
In order to set quota submit POST request to /api/openstack-tenants/<uuid>/set_quotas/.
The quota values are propagated to the backend.

The following quotas are supported. All values ar...
Path parameters:
  - uuid
Request body: yes

### openstack_tenants_topology_retrieve
GET /api/openstack-tenants/{uuid}/topology/
Summary: Tenant network topology
Description: Compose the tenant's network topology — routers, networks, subnets, ports, instances, floating IPs, external networks, and inbound RBAC shares — as a graph (nodes + edges). Read-only; all data comes from already-pulled state, no Neutron calls.
Path parameters:
  - uuid

### openstack_tenants_unlink
POST /api/openstack-tenants/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## openstack-volume-availability-zones  (module: waldur_api_client.api.openstack_volume_availability_zones)
============================================================

### openstack_volume_availability_zones_list
GET /api/openstack-volume-availability-zones/
Summary: List volume availability zones
Description: Get a list of volume availability zones.
Query parameters (6):
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_volume_availability_zones_count
HEAD /api/openstack-volume-availability-zones/
Summary: List volume availability zones
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_volume_availability_zones_retrieve
GET /api/openstack-volume-availability-zones/{uuid}/
Summary: Get volume availability zone details
Description: Retrieve details of a specific volume availability zone.
Path parameters:
  - uuid

============================================================
## openstack-volume-types  (module: waldur_api_client.api.openstack_volume_types)
============================================================

### openstack_volume_types_list
GET /api/openstack-volume-types/
Summary: List volume types
Description: Get a list of available volume types.
Query parameters (7):
  - name — Name
  - name_exact — Name (exact)
  - offering_uuid — Offering UUID
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_volume_types_count
HEAD /api/openstack-volume-types/
Summary: List volume types
Description: Get number of items in the collection matching the request parameters.
Query parameters (7):
  - name — Name
  - name_exact — Name (exact)
  - offering_uuid — Offering UUID
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_volume_types_names_retrieve
GET /api/openstack-volume-types/names/
Summary: List unique volume type names
Description: Return a list of unique volume type names.

### openstack_volume_types_names_count
HEAD /api/openstack-volume-types/names/
Summary: List unique volume type names
Description: Get number of items in the collection matching the request parameters.

### openstack_volume_types_retrieve
GET /api/openstack-volume-types/{uuid}/
Summary: Get volume type details
Description: Retrieve details of a specific volume type.
Path parameters:
  - uuid

============================================================
## openstack-volumes  (module: waldur_api_client.api.openstack_volumes)
============================================================

### openstack_volumes_list
GET /api/openstack-volumes/
Summary: List volumes
Description: Get a list of volumes.
Query parameters (27):
  - attach_instance_uuid — Filter for attachment to instance UUID
  - availability_zone_name — Availability zone name
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - instance — Instance URL
  - instance_uuid — Instance UUID
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - runtime_state
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - snapshot — Snapshot URL
  - snapshot_uuid — Snapshot UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_volumes_count
HEAD /api/openstack-volumes/
Summary: List volumes
Description: Get number of items in the collection matching the request parameters.
Query parameters (26):
  - attach_instance_uuid — Filter for attachment to instance UUID
  - availability_zone_name — Availability zone name
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - instance — Instance URL
  - instance_uuid — Instance UUID
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - runtime_state
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - snapshot — Snapshot URL
  - snapshot_uuid — Snapshot UUID
  - state — State
  - tenant — Tenant URL
  - tenant_uuid — Tenant UUID

### openstack_volumes_retrieve
GET /api/openstack-volumes/{uuid}/
Summary: Get volume details
Description: Retrieve details of a specific volume.
Path parameters:
  - uuid
Query parameters (1):
  - field

### openstack_volumes_update
PUT /api/openstack-volumes/{uuid}/
Summary: Update volume
Description: Update an existing volume.
Path parameters:
  - uuid
Request body: yes

### openstack_volumes_partial_update
PATCH /api/openstack-volumes/{uuid}/
Summary: Partially update volume
Description: Update specific fields of a volume.
Path parameters:
  - uuid
Request body: yes

### openstack_volumes_attach
POST /api/openstack-volumes/{uuid}/attach/
Summary: Attach volume to instance
Path parameters:
  - uuid
Request body: yes

### openstack_volumes_detach
POST /api/openstack-volumes/{uuid}/detach/
Summary: Detach volume from instance
Description: Detach instance from volume
Path parameters:
  - uuid

### openstack_volumes_extend
POST /api/openstack-volumes/{uuid}/extend/
Summary: Extend volume size
Description: Increase volume size
Path parameters:
  - uuid
Request body: yes

### openstack_volumes_pull
POST /api/openstack-volumes/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### openstack_volumes_retype
POST /api/openstack-volumes/{uuid}/retype/
Summary: Change volume type
Description: Retype detached volume
Path parameters:
  - uuid
Request body: yes

### openstack_volumes_set_erred
POST /api/openstack-volumes/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### openstack_volumes_set_ok
POST /api/openstack-volumes/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### openstack_volumes_snapshot
POST /api/openstack-volumes/{uuid}/snapshot/
Summary: Create volume snapshot
Description: Create snapshot from volume
Path parameters:
  - uuid
Request body: yes

### openstack_volumes_unlink
POST /api/openstack-volumes/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## organization-groups  (module: waldur_api_client.api.organization_groups)
============================================================

### organization_groups_list
GET /api/organization-groups/
Query parameters (4):
  - name — Name
  - name_exact — Name (exact)
  - o — Which field to use when ordering the results.
  - parent — Parent UUID

### organization_groups_count
HEAD /api/organization-groups/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - name — Name
  - name_exact — Name (exact)
  - o — Which field to use when ordering the results.
  - parent — Parent UUID

### organization_groups_create
POST /api/organization-groups/
Request body: yes

### organization_groups_retrieve
GET /api/organization-groups/{uuid}/
Path parameters:
  - uuid

### organization_groups_update
PUT /api/organization-groups/{uuid}/
Path parameters:
  - uuid
Request body: yes

### organization_groups_partial_update
PATCH /api/organization-groups/{uuid}/
Path parameters:
  - uuid
Request body: yes

### organization_groups_destroy
DELETE /api/organization-groups/{uuid}/
Path parameters:
  - uuid

============================================================
## override-settings  (module: waldur_api_client.api.override_settings)
============================================================

### override_settings_retrieve
GET /api/override-settings/
Summary: Get all overridable settings
Description: Returns all settings that can be overridden in the database via the Constance backend. Requires admin permissions.

### override_settings
POST /api/override-settings/
Summary: Update overridable settings
Description: Updates one or more settings in the database via the Constance backend. Requires admin permissions.
Request body: yes

============================================================
## payment-profiles  (module: waldur_api_client.api.payment_profiles)
============================================================

### payment_profiles_list
GET /api/payment-profiles/
Query parameters (5):
  - is_active
  - o — Ordering
  - organization
  - organization_uuid
  - payment_type

### payment_profiles_count
HEAD /api/payment-profiles/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - is_active
  - o — Ordering
  - organization
  - organization_uuid
  - payment_type

### payment_profiles_create
POST /api/payment-profiles/
Request body: yes

### payment_profiles_retrieve
GET /api/payment-profiles/{uuid}/
Path parameters:
  - uuid

### payment_profiles_update
PUT /api/payment-profiles/{uuid}/
Path parameters:
  - uuid
Request body: yes

### payment_profiles_partial_update
PATCH /api/payment-profiles/{uuid}/
Path parameters:
  - uuid
Request body: yes

### payment_profiles_destroy
DELETE /api/payment-profiles/{uuid}/
Path parameters:
  - uuid

### payment_profiles_enable
POST /api/payment-profiles/{uuid}/enable/
Path parameters:
  - uuid

============================================================
## payments  (module: waldur_api_client.api.payments)
============================================================

### payments_list
GET /api/payments/
Query parameters (3):
  - date_of_payment
  - profile
  - profile_uuid

### payments_count
HEAD /api/payments/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - date_of_payment
  - profile
  - profile_uuid

### payments_create
POST /api/payments/
Request body: yes

### payments_retrieve
GET /api/payments/{uuid}/
Path parameters:
  - uuid

### payments_update
PUT /api/payments/{uuid}/
Path parameters:
  - uuid
Request body: yes

### payments_partial_update
PATCH /api/payments/{uuid}/
Path parameters:
  - uuid
Request body: yes

### payments_destroy
DELETE /api/payments/{uuid}/
Path parameters:
  - uuid

### payments_link_to_invoice
POST /api/payments/{uuid}/link_to_invoice/
Summary: Link a payment to an invoice
Description: Link a payment to an invoice. Payment can be linked to an invoice only if they belong to the same customer.
Path parameters:
  - uuid
Request body: yes

### payments_unlink_from_invoice
POST /api/payments/{uuid}/unlink_from_invoice/
Summary: Unlink a payment from an invoice
Description: Unlink a payment from an invoice. Remove connection between payment and existing linked invoice.
Path parameters:
  - uuid

============================================================
## personal-access-tokens  (module: waldur_api_client.api.personal_access_tokens)
============================================================

### personal_access_tokens_list
GET /api/personal-access-tokens/

### personal_access_tokens_count
HEAD /api/personal-access-tokens/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### personal_access_tokens_create
POST /api/personal-access-tokens/
Summary: Create a personal access token
Request body: yes

### personal_access_tokens_available_binding_targets_list
GET /api/personal-access-tokens/available_binding_targets/
Summary: List entity types the caller can bind each permission to
Description: For each permission, which TYPE_MAP keys the caller could bind a PAT to.

Drives the create-PAT frontend's type picker. For staff users every
type is offered for every permission (they bypass UserRole checks).
For other users we return only types where they hold an active role
granting the permis...

### personal_access_tokens_available_binding_targets_count
HEAD /api/personal-access-tokens/available_binding_targets/
Summary: List entity types the caller can bind each permission to
Description: Get number of items in the collection matching the request parameters.

### personal_access_tokens_available_scopes_list
GET /api/personal-access-tokens/available_scopes/
Summary: List available scopes for PAT creation
Description: Return permissions the current user can delegate to a PAT.

Staff users can delegate any permission (they bypass UserRole checks).
For other users only the permissions granted by their active roles are
offered, plus SUPPORT.ACCESS for support users — mirroring what the
create serializer would acc...

### personal_access_tokens_available_scopes_count
HEAD /api/personal-access-tokens/available_scopes/
Summary: List available scopes for PAT creation
Description: Get number of items in the collection matching the request parameters.

### personal_access_tokens_retrieve
GET /api/personal-access-tokens/{uuid}/
Path parameters:
  - uuid

### personal_access_tokens_destroy
DELETE /api/personal-access-tokens/{uuid}/
Summary: Revoke a personal access token
Path parameters:
  - uuid

### personal_access_tokens_rotate
POST /api/personal-access-tokens/{uuid}/rotate/
Summary: Rotate a personal access token
Description: Atomically revoke the old token and create a new one with the same scopes and bindings.
Path parameters:
  - uuid

============================================================
## project-credits  (module: waldur_api_client.api.project_credits)
============================================================

### project_credits_list
GET /api/project-credits/
Query parameters (7):
  - customer_name
  - customer_slug
  - customer_uuid
  - o — Ordering
  - project_name
  - project_uuid
  - query

### project_credits_count
HEAD /api/project-credits/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (7):
  - customer_name
  - customer_slug
  - customer_uuid
  - o — Ordering
  - project_name
  - project_uuid
  - query

### project_credits_create
POST /api/project-credits/
Request body: yes

### project_credits_retrieve
GET /api/project-credits/{uuid}/
Path parameters:
  - uuid

### project_credits_update
PUT /api/project-credits/{uuid}/
Path parameters:
  - uuid
Request body: yes

### project_credits_partial_update
PATCH /api/project-credits/{uuid}/
Path parameters:
  - uuid
Request body: yes

### project_credits_destroy
DELETE /api/project-credits/{uuid}/
Path parameters:
  - uuid

============================================================
## project-end-date-change-requests  (module: waldur_api_client.api.project_end_date_change_requests)
============================================================

### project_end_date_change_requests_list
GET /api/project-end-date-change-requests/
Query parameters (4):
  - created_by_uuid — Created by UUID
  - customer_uuid — Customer UUID
  - project_uuid — Project UUID
  - state

### project_end_date_change_requests_count
HEAD /api/project-end-date-change-requests/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - created_by_uuid — Created by UUID
  - customer_uuid — Customer UUID
  - project_uuid — Project UUID
  - state

### project_end_date_change_requests_create
POST /api/project-end-date-change-requests/
Request body: yes

### project_end_date_change_requests_retrieve
GET /api/project-end-date-change-requests/{uuid}/
Path parameters:
  - uuid

### project_end_date_change_requests_approve
POST /api/project-end-date-change-requests/{uuid}/approve/
Summary: Approve project end date change request
Path parameters:
  - uuid
Request body: yes

### project_end_date_change_requests_cancel
POST /api/project-end-date-change-requests/{uuid}/cancel/
Summary: Cancel project end date change request
Description: Cancel project end date change request. Only the creator can cancel.
Path parameters:
  - uuid

### project_end_date_change_requests_reject
POST /api/project-end-date-change-requests/{uuid}/reject/
Summary: Reject project end date change request
Path parameters:
  - uuid
Request body: yes

============================================================
## project-permissions-reviews  (module: waldur_api_client.api.project_permissions_reviews)
============================================================

### project_permissions_reviews_list
GET /api/project-permissions-reviews/
Query parameters (5):
  - closed
  - is_pending — Is pending
  - o — Ordering
  - project_uuid — Project UUID
  - reviewer_uuid — Reviewer UUID

### project_permissions_reviews_count
HEAD /api/project-permissions-reviews/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - closed
  - is_pending — Is pending
  - o — Ordering
  - project_uuid — Project UUID
  - reviewer_uuid — Reviewer UUID

### project_permissions_reviews_retrieve
GET /api/project-permissions-reviews/{uuid}/
Path parameters:
  - uuid

### project_permissions_reviews_close
POST /api/project-permissions-reviews/{uuid}/close/
Summary: Close project permission review
Description: Complete project permission review.
Path parameters:
  - uuid

============================================================
## project-quotas  (module: waldur_api_client.api.project_quotas)
============================================================

### project_quotas_list
GET /api/project-quotas/
Summary: List project quotas
Description: List project quotas.
Query parameters (1):
  - quota_name — Name of the quota

### project_quotas_count
HEAD /api/project-quotas/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - quota_name — Name of the quota

============================================================
## project-types  (module: waldur_api_client.api.project_types)
============================================================

### project_types_list
GET /api/project-types/
Summary: List project types
Description: Retrieve a list of available project types.
Query parameters (2):
  - name — Name
  - name_exact — Name (exact)

### project_types_count
HEAD /api/project-types/
Summary: List project types
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - name — Name
  - name_exact — Name (exact)

### project_types_retrieve
GET /api/project-types/{uuid}/
Summary: Retrieve project type details
Description: Fetch details of a specific project type by its UUID.
Path parameters:
  - uuid

============================================================
## projects  (module: waldur_api_client.api.projects)
============================================================

### projects_list
GET /api/projects/
Summary: List projects
Description: Retrieve a list of projects. The list is filtered based on the user's permissions. By default, only active projects are shown.
Query parameters (30):
  - accounting_is_running — Filter by whether accounting is running.
  - affiliation_name — Affiliation name
  - affiliation_uuid — Affiliation UUID
  - backend_id
  - can_admin — Return a list of projects where current user is admin.
  - can_manage — Return a list of projects where current user is manager or a customer owner.
  - conceal_finished_projects — Conceal finished projects
  - created — Created after
  - created_before — Created before
  - current_user_has_role — Multiple values may be separated by commas.
  - customer — Multiple values may be separated by commas.
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - description — Description
  - field
  - has_affiliation — Filter projects that have an affiliation.
  - include_terminated — Include soft-deleted (terminated) projects. Only available to staff and support users, or users with organizational roles who can see their terminated projects.
  - is_removed — Is removed
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - query — Filter by name, slug, UUID, backend ID or resource effective ID
  - science_domain_uuid — Science domain UUID
  - science_sub_domain_uuid — Science sub-domain UUID
  - slug — Slug
  - user_uuid — Filter by user UUID.
  - user_uuid_with_active_role — Filter projects where the given user has a role.

### projects_count
HEAD /api/projects/
Summary: List projects
Description: Get number of items in the collection matching the request parameters.
Query parameters (29):
  - accounting_is_running — Filter by whether accounting is running.
  - affiliation_name — Affiliation name
  - affiliation_uuid — Affiliation UUID
  - backend_id
  - can_admin — Return a list of projects where current user is admin.
  - can_manage — Return a list of projects where current user is manager or a customer owner.
  - conceal_finished_projects — Conceal finished projects
  - created — Created after
  - created_before — Created before
  - current_user_has_role — Multiple values may be separated by commas.
  - customer — Multiple values may be separated by commas.
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - description — Description
  - has_affiliation — Filter projects that have an affiliation.
  - include_terminated — Include soft-deleted (terminated) projects. Only available to staff and support users, or users with organizational roles who can see their terminated projects.
  - is_removed — Is removed
  - modified — Modified after
  - modified_before — Modified before
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - query — Filter by name, slug, UUID, backend ID or resource effective ID
  - science_domain_uuid — Science domain UUID
  - science_sub_domain_uuid — Science sub-domain UUID
  - slug — Slug
  - user_uuid — Filter by user UUID.
  - user_uuid_with_active_role — Filter projects where the given user has a role.

### projects_create
POST /api/projects/
Summary: Create a new project
Description: A new project can be created by users with staff privilege (is_staff=True) or customer owners. Project resource quota is optional.
Request body: yes

### projects_checklist_template_retrieve
GET /api/projects/checklist-template/
Summary: Get checklist template for creating new objects
Description: Get checklist template for creating new objects.
Query parameters (1):
  - parent_uuid (required) — UUID of the parent object (e.g., customer UUID for new projects)

### projects_checklist_template_count
HEAD /api/projects/checklist-template/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - parent_uuid (required) — UUID of the parent object (e.g., customer UUID for new projects)

### projects_other_users_list
GET /api/projects/{project_uuid}/other_users/
Summary: A list of users which can be added to the current project from other projects of the same customer
Description: A list of users which can be added to the current project from other projects of the same customer.
Path parameters:
  - project_uuid — UUID of the project
Query parameters (16):
  - agreement_date — Agreement date after
  - civil_number
  - date_joined — Date joined after
  - description
  - email — Email
  - full_name — Full name
  - is_active — Is active
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering. Sort by a combination of first name, last name, and username.
  - organization — Organization
  - phone_number
  - registration_method
  - user_keyword — User keyword
  - username — Username

### projects_other_users_count
HEAD /api/projects/{project_uuid}/other_users/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - project_uuid — UUID of the project
Query parameters (16):
  - agreement_date — Agreement date after
  - civil_number
  - date_joined — Date joined after
  - description
  - email — Email
  - full_name — Full name
  - is_active — Is active
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering. Sort by a combination of first name, last name, and username.
  - organization — Organization
  - phone_number
  - registration_method
  - user_keyword — User keyword
  - username — Username

### projects_retrieve
GET /api/projects/{uuid}/
Summary: Retrieve project details
Description: Fetch the details of a specific project by its UUID. Users can access details of terminated projects they previously had access to.
Path parameters:
  - uuid
Query parameters (1):
  - field

### projects_update
PUT /api/projects/{uuid}/
Summary: Update project details
Description: Update the details of a project. Requires project administrator or customer owner permissions.
Path parameters:
  - uuid
Request body: yes

### projects_partial_update
PATCH /api/projects/{uuid}/
Summary: Partially update project details
Description: Partially update the details of a project. Requires project administrator or customer owner permissions.
Path parameters:
  - uuid
Request body: yes

### projects_destroy
DELETE /api/projects/{uuid}/
Summary: Delete a project
Description: Delete a project. If the project has any active resources, the deletion request will fail with a 409 Conflict response. This action performs a soft-delete, and the project can be recovered later.
Path parameters:
  - uuid

### projects_add_user
POST /api/projects/{uuid}/add_user/
Summary: Grant a role to a user
Description: Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
Path parameters:
  - uuid
Request body: yes

### projects_checklist_retrieve
GET /api/projects/{uuid}/checklist/
Summary: Get checklist with questions and existing answers
Description: Get checklist with questions and existing answers.
Path parameters:
  - uuid
Query parameters (1):
  - include_all — If true, returns all questions including hidden ones (for dynamic form visibility). Default: false.

### projects_completion_status_retrieve
GET /api/projects/{uuid}/completion_status/
Summary: Get checklist completion status
Description: Get checklist completion status.
Path parameters:
  - uuid

### projects_delete_user
POST /api/projects/{uuid}/delete_user/
Summary: Revoke a role from a user
Description: Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
Path parameters:
  - uuid
Request body: yes

### projects_list_users_list
GET /api/projects/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### projects_list_users_count
HEAD /api/projects/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### projects_move_project
POST /api/projects/{uuid}/move_project/
Summary: Move project to another customer
Description: Moves a project and its associated resources to a different customer. You can choose whether to preserve existing project permissions for users. Terminated projects can also be moved.
Path parameters:
  - uuid
Request body: yes

### projects_recover
POST /api/projects/{uuid}/recover/
Summary: Recover a soft-deleted project
Description: Recovers a soft-deleted (terminated) project, making it active again. Provides options to restore previous team members automatically (staff-only) or send them new invitations.
Path parameters:
  - uuid
Request body: yes

### projects_stats_retrieve
GET /api/projects/{uuid}/stats/
Summary: Get project resource usage statistics
Description: Provides statistics about the resource usage (e.g., CPU, RAM, storage) for all resources within a project. Can be filtered to show usage for the current month only.
Path parameters:
  - uuid
Query parameters (1):
  - for_current_month — If true, returns usage data for the current month only. Otherwise, returns total usage.

### projects_submit_answers
POST /api/projects/{uuid}/submit_answers/
Summary: Submit checklist answers
Description: Submit checklist answers.
Path parameters:
  - uuid
Request body: yes

### projects_sync_user_roles
POST /api/projects/{uuid}/sync_user_roles/
Summary: Trigger user role sync for this project
Description: Trigger user role sync for this project. Sends a notification to RabbitMQ that this project needs user role synchronization.
Path parameters:
  - uuid

### projects_update_affiliation
POST /api/projects/{uuid}/update_affiliation/
Summary: Update affiliation for a project
Description: Assigns the project to a single affiliation (or clears it when null).
Path parameters:
  - uuid
Request body: yes

### projects_update_user
POST /api/projects/{uuid}/update_user/
Summary: Update a user's role expiration
Description: Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
Path parameters:
  - uuid
Request body: yes

============================================================
## promotions-campaigns  (module: waldur_api_client.api.promotions_campaigns)
============================================================

### promotions_campaigns_list
GET /api/promotions-campaigns/
Query parameters (9):
  - discount_type
  - end_date
  - o — Ordering
  - offering — Offering
  - offering_uuid
  - query — Search by name or coupon code
  - service_provider_uuid
  - start_date
  - state

### promotions_campaigns_count
HEAD /api/promotions-campaigns/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - discount_type
  - end_date
  - o — Ordering
  - offering — Offering
  - offering_uuid
  - query — Search by name or coupon code
  - service_provider_uuid
  - start_date
  - state

### promotions_campaigns_create
POST /api/promotions-campaigns/
Request body: yes

### promotions_campaigns_retrieve
GET /api/promotions-campaigns/{uuid}/
Path parameters:
  - uuid

### promotions_campaigns_update
PUT /api/promotions-campaigns/{uuid}/
Path parameters:
  - uuid
Request body: yes

### promotions_campaigns_destroy
DELETE /api/promotions-campaigns/{uuid}/
Path parameters:
  - uuid

### promotions_campaigns_activate
POST /api/promotions-campaigns/{uuid}/activate/
Summary: Activate campaign
Description: Activate campaign.
Path parameters:
  - uuid

### promotions_campaigns_orders_list
GET /api/promotions-campaigns/{uuid}/orders/
Summary: Return a list of orders for which the campaign is applied
Description: Return a list of orders for which the campaign is applied.
Path parameters:
  - uuid
Query parameters (1):
  - field

### promotions_campaigns_resources_list
GET /api/promotions-campaigns/{uuid}/resources/
Summary: Return a list of resources for which the campaign is applied
Description: Return a list of resources for which the campaign is applied.
Path parameters:
  - uuid
Query parameters (1):
  - field

### promotions_campaigns_terminate
POST /api/promotions-campaigns/{uuid}/terminate/
Summary: Terminate campaign
Description: Terminate campaign.
Path parameters:
  - uuid

============================================================
## proposal-proposals  (module: waldur_api_client.api.proposal_proposals)
============================================================

### proposal_proposals_list
GET /api/proposal-proposals/
Query parameters (10):
  - call_uuid
  - created_by_uuid
  - my_proposals
  - name
  - o — Ordering
  - organization_uuid
  - round
  - round_uuid
  - slug — Slug
  - state

### proposal_proposals_count
HEAD /api/proposal-proposals/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (10):
  - call_uuid
  - created_by_uuid
  - my_proposals
  - name
  - o — Ordering
  - organization_uuid
  - round
  - round_uuid
  - slug — Slug
  - state

### proposal_proposals_create
POST /api/proposal-proposals/
Request body: yes

### proposal_proposals_checklist_template_retrieve
GET /api/proposal-proposals/checklist-template/
Summary: Get checklist template for creating new objects
Description: Get checklist template for creating new objects.
Query parameters (1):
  - parent_uuid (required) — UUID of the parent object (e.g., customer UUID for new projects)

### proposal_proposals_checklist_template_count
HEAD /api/proposal-proposals/checklist-template/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - parent_uuid (required) — UUID of the parent object (e.g., customer UUID for new projects)

### proposal_proposals_retrieve
GET /api/proposal-proposals/{uuid}/
Path parameters:
  - uuid

### proposal_proposals_destroy
DELETE /api/proposal-proposals/{uuid}/
Path parameters:
  - uuid

### proposal_proposals_add_user
POST /api/proposal-proposals/{uuid}/add_user/
Summary: Grant a role to a user
Description: Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
Path parameters:
  - uuid
Request body: yes

### proposal_proposals_advance_workflow_step
POST /api/proposal-proposals/{uuid}/advance_workflow_step/
Summary: Manually advance a workflow that is awaiting call-manager confirmation
Description: Manually advance a workflow that is awaiting call-manager confirmation.
Path parameters:
  - uuid

### proposal_proposals_approve
POST /api/proposal-proposals/{uuid}/approve/
Summary: Approve a proposal
Description: Approve a proposal.
Path parameters:
  - uuid
Request body: yes

### proposal_proposals_attach_document
POST /api/proposal-proposals/{uuid}/attach_document/
Summary: Attach document to proposal
Description: Attach document to proposal.
Path parameters:
  - uuid
Request body: yes

### proposal_proposals_checklist_retrieve
GET /api/proposal-proposals/{uuid}/checklist/
Summary: Get checklist with questions and existing answers
Description: Get checklist with questions and existing answers.
Path parameters:
  - uuid
Query parameters (1):
  - include_all — If true, returns all questions including hidden ones (for dynamic form visibility). Default: false.

### proposal_proposals_checklist_review_retrieve
GET /api/proposal-proposals/{uuid}/checklist_review/
Summary: Get checklist with questions and existing answers including review logic (reviewers only)
Description: Get checklist with questions and existing answers including review logic (reviewers only).
Path parameters:
  - uuid

### proposal_proposals_complete_workflow_step
POST /api/proposal-proposals/{uuid}/complete_workflow_step/
Summary: Complete the current workflow step with an outcome
Description: Complete the current workflow step with an outcome.
Path parameters:
  - uuid
Request body: yes

### proposal_proposals_completion_review_status_retrieve
GET /api/proposal-proposals/{uuid}/completion_review_status/
Summary: Get checklist completion status with review triggers (reviewers only)
Description: Get checklist completion status with review triggers (reviewers only).
Path parameters:
  - uuid

### proposal_proposals_completion_status_retrieve
GET /api/proposal-proposals/{uuid}/completion_status/
Summary: Get checklist completion status
Description: Get checklist completion status.
Path parameters:
  - uuid

### proposal_proposals_delete_user
POST /api/proposal-proposals/{uuid}/delete_user/
Summary: Revoke a role from a user
Description: Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
Path parameters:
  - uuid
Request body: yes

### proposal_proposals_detach_documents
POST /api/proposal-proposals/{uuid}/detach_documents/
Summary: Detach documents from proposal
Description: Detach documents from proposal.
Path parameters:
  - uuid
Request body: yes

### proposal_proposals_list_users_list
GET /api/proposal-proposals/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### proposal_proposals_list_users_count
HEAD /api/proposal-proposals/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### proposal_proposals_reject
POST /api/proposal-proposals/{uuid}/reject/
Summary: Reject a proposal
Description: Reject a proposal.
Path parameters:
  - uuid
Request body: yes

### proposal_proposals_reject_workflow_step
POST /api/proposal-proposals/{uuid}/reject_workflow_step/
Summary: Reject the proposal at the current workflow step
Description: Reject the proposal at the current workflow step.
Path parameters:
  - uuid
Request body: yes

### proposal_proposals_resources_list
GET /api/proposal-proposals/{uuid}/resources/
Summary: List resources for a proposal
Description: List resources for a proposal.
Path parameters:
  - uuid

### proposal_proposals_resources_set
POST /api/proposal-proposals/{uuid}/resources/
Summary: Create resource for a proposal
Description: Create resource for a proposal.
Path parameters:
  - uuid
Request body: yes

### proposal_proposals_resources_retrieve
GET /api/proposal-proposals/{uuid}/resources/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid

### proposal_proposals_resources_update
PUT /api/proposal-proposals/{uuid}/resources/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid
Request body: yes

### proposal_proposals_resources_partial_update
PATCH /api/proposal-proposals/{uuid}/resources/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid
Request body: yes

### proposal_proposals_resources_destroy
DELETE /api/proposal-proposals/{uuid}/resources/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid

### proposal_proposals_submit
POST /api/proposal-proposals/{uuid}/submit/
Summary: Submit a proposal
Description: Submit a proposal.
Path parameters:
  - uuid

### proposal_proposals_submit_answers
POST /api/proposal-proposals/{uuid}/submit_answers/
Summary: Submit checklist answers
Description: Submit checklist answers.
Path parameters:
  - uuid
Request body: yes

### proposal_proposals_update_project_details
POST /api/proposal-proposals/{uuid}/update_project_details/
Summary: Update project details of a proposal
Description: Update project details of a proposal.
Path parameters:
  - uuid
Request body: yes

### proposal_proposals_update_user
POST /api/proposal-proposals/{uuid}/update_user/
Summary: Update a user's role expiration
Description: Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
Path parameters:
  - uuid
Request body: yes

### proposal_proposals_workflow_states_list
GET /api/proposal-proposals/{uuid}/workflow_states/
Summary: List all workflow step instances for this proposal
Description: List all workflow step instances for this proposal.
Path parameters:
  - uuid
Query parameters (10):
  - call_uuid
  - created_by_uuid
  - my_proposals
  - name
  - o — Ordering
  - organization_uuid
  - round
  - round_uuid
  - slug — Slug
  - state

============================================================
## proposal-protected-calls  (module: waldur_api_client.api.proposal_protected_calls)
============================================================

### proposal_protected_calls_list
GET /api/proposal-protected-calls/
Query parameters (11):
  - customer
  - customer_keyword
  - customer_uuid
  - field
  - has_active_round
  - name
  - o — Ordering
  - offering_uuid
  - offerings_provider_uuid
  - slug — Slug
  - state

### proposal_protected_calls_count
HEAD /api/proposal-protected-calls/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (10):
  - customer
  - customer_keyword
  - customer_uuid
  - has_active_round
  - name
  - o — Ordering
  - offering_uuid
  - offerings_provider_uuid
  - slug — Slug
  - state

### proposal_protected_calls_create
POST /api/proposal-protected-calls/
Request body: yes

### proposal_protected_calls_available_compliance_checklists_list
GET /api/proposal-protected-calls/available_compliance_checklists/
Summary: Get available compliance checklists for call creation/editing
Description: Get available compliance checklists for call creation/editing.
Query parameters (11):
  - checklist_type — Filter by checklist type (default: proposal_compliance)
  - customer
  - customer_keyword
  - customer_uuid (required) — Customer UUID to check permissions for. Required to verify user has CREATE_CALL permission on that customer's call managing organization.
  - has_active_round
  - name
  - o — Ordering
  - offering_uuid
  - offerings_provider_uuid
  - slug — Slug
  - state

### proposal_protected_calls_available_compliance_checklists_count
HEAD /api/proposal-protected-calls/available_compliance_checklists/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (11):
  - checklist_type — Filter by checklist type (default: proposal_compliance)
  - customer
  - customer_keyword
  - customer_uuid (required) — Customer UUID to check permissions for. Required to verify user has CREATE_CALL permission on that customer's call managing organization.
  - has_active_round
  - name
  - o — Ordering
  - offering_uuid
  - offerings_provider_uuid
  - slug — Slug
  - state

### proposal_protected_calls_retrieve
GET /api/proposal-protected-calls/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### proposal_protected_calls_update
PUT /api/proposal-protected-calls/{uuid}/
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_partial_update
PATCH /api/proposal-protected-calls/{uuid}/
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_destroy
DELETE /api/proposal-protected-calls/{uuid}/
Path parameters:
  - uuid

### proposal_protected_calls_activate
POST /api/proposal-protected-calls/{uuid}/activate/
Summary: Activate a call
Description: Activate a call.
Path parameters:
  - uuid

### proposal_protected_calls_add_user
POST /api/proposal-protected-calls/{uuid}/add_user/
Summary: Grant a role to a user
Description: Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_affinity_matrix_retrieve
GET /api/proposal-protected-calls/{uuid}/affinity-matrix/
Summary: Get affinity matrix for reviewer-proposal matching
Description: Get affinity matrix for reviewer-proposal matching.
Path parameters:
  - uuid
Query parameters (1):
  - scope — Filter by reviewer source: 'pool' (accepted reviewers), 'suggestions' (suggested reviewers), or 'all' (both). Default: 'pool'

### proposal_protected_calls_archive
POST /api/proposal-protected-calls/{uuid}/archive/
Summary: Archive a call
Description: Archive a call.
Path parameters:
  - uuid

### proposal_protected_calls_attach_documents
POST /api/proposal-protected-calls/{uuid}/attach_documents/
Summary: Attach documents to call
Description: Attach documents to call.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_coi_configuration_retrieve
GET /api/proposal-protected-calls/{uuid}/coi-configuration/
Summary: Get COI configuration for this call
Description: Get COI configuration for this call.
Path parameters:
  - uuid

### proposal_protected_calls_coi_configuration_partial_update
PATCH /api/proposal-protected-calls/{uuid}/coi-configuration/
Summary: Get COI configuration for this call
Description: Get COI configuration for this call.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_compliance_overview_retrieve
GET /api/proposal-protected-calls/{uuid}/compliance_overview/
Summary: Get compliance overview for call manager showing all proposals and their compliance status
Description: Get compliance overview for call manager showing all proposals and their compliance status.
Path parameters:
  - uuid

### proposal_protected_calls_compute_affinities
POST /api/proposal-protected-calls/{uuid}/compute-affinities/
Summary: Compute affinity scores for all reviewer-proposal pairs
Description: Compute affinity scores for all reviewer-proposal pairs.
Path parameters:
  - uuid

### proposal_protected_calls_conflict_summary_retrieve
GET /api/proposal-protected-calls/{uuid}/conflict-summary/
Summary: Get summary statistics of conflicts for this call
Description: Get summary statistics of conflicts for this call.
Path parameters:
  - uuid

### proposal_protected_calls_conflicts_list
GET /api/proposal-protected-calls/{uuid}/conflicts/
Summary: List all conflicts of interest detected for this call
Description: List all conflicts of interest detected for this call.
Path parameters:
  - uuid
Query parameters (10):
  - customer
  - customer_keyword
  - customer_uuid
  - has_active_round
  - name
  - o — Ordering
  - offering_uuid
  - offerings_provider_uuid
  - slug — Slug
  - state

### proposal_protected_calls_create_manual_assignment
POST /api/proposal-protected-calls/{uuid}/create-manual-assignment/
Summary: Create a manual assignment batch for a specific reviewer
Description: Create a manual assignment batch for a specific reviewer. This allows call managers to manually assign proposals to reviewers.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_delete_user
POST /api/proposal-protected-calls/{uuid}/delete_user/
Summary: Revoke a role from a user
Description: Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_detach_documents
POST /api/proposal-protected-calls/{uuid}/detach_documents/
Summary: Detach documents from call
Description: Detach documents from call.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_detect_conflicts
POST /api/proposal-protected-calls/{uuid}/detect-conflicts/
Summary: Trigger automated COI detection for all reviewer-proposal pairs
Description: Trigger automated COI detection for all reviewer-proposal pairs.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_duplicate
POST /api/proposal-protected-calls/{uuid}/duplicate/
Summary: Duplicate a call
Description: Duplicate a call. The new call inherits the source call's configuration (offerings, rounds, workflow steps, resource templates, role mappings, documents, and COI/matching/assignment/applicant-visibility settings) and starts in draft state. Proposals, reviews, team permissions, and reviewer-pool m...
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_generate_assignments
POST /api/proposal-protected-calls/{uuid}/generate-assignments/
Summary: Generate assignment batches for reviewers
Description: Generate assignment batches for reviewers. Uses the affinity matrix and COI records to assign reviewers to proposals.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_generate_suggestions
POST /api/proposal-protected-calls/{uuid}/generate-suggestions/
Summary: Generate reviewer suggestions with configurable matching source
Description: Generate reviewer suggestions with configurable matching source.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_invite_by_email
POST /api/proposal-protected-calls/{uuid}/invite-by-email/
Summary: Invite a reviewer by email address
Description: Invite a reviewer by email address. Creates an invitation that requires the reviewer to create and publish a profile before accepting.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_list_users_list
GET /api/proposal-protected-calls/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### proposal_protected_calls_list_users_count
HEAD /api/proposal-protected-calls/{uuid}/list_users/
Summary: List users and their roles in a scope
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - uuid
Query parameters (10):
  - field — Fields to include in response
  - full_name — User full name
  - native_name — User native name
  - o — Ordering fields
  - role — Role UUID or name
  - search_string — Search string for user
  - user — User UUID
  - user_slug — User slug
  - user_url — User URL
  - username — User username

### proposal_protected_calls_matching_configuration_retrieve
GET /api/proposal-protected-calls/{uuid}/matching-configuration/
Summary: Get or update matching configuration for this call
Description: Get or update matching configuration for this call.
Path parameters:
  - uuid

### proposal_protected_calls_matching_configuration_partial_update
PATCH /api/proposal-protected-calls/{uuid}/matching-configuration/
Summary: Get or update matching configuration for this call
Description: Get or update matching configuration for this call.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_offerings_list
GET /api/proposal-protected-calls/{uuid}/offerings/
Summary: List offerings for a call
Description: List offerings for a call.
Path parameters:
  - uuid
Query parameters (1):
  - state — Filter by state

### proposal_protected_calls_offerings_set
POST /api/proposal-protected-calls/{uuid}/offerings/
Summary: Create offering for a call
Description: Create offering for a call.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_offerings_retrieve
GET /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid

### proposal_protected_calls_offerings_update
PUT /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid
Request body: yes

### proposal_protected_calls_offerings_partial_update
PATCH /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid
Request body: yes

### proposal_protected_calls_offerings_destroy
DELETE /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid

### proposal_protected_calls_proposals_compliance_answers_list
GET /api/proposal-protected-calls/{uuid}/proposals/{proposal_uuid}/compliance-answers/
Summary: Get detailed compliance answers for a specific proposal (call managers only)
Description: Get detailed compliance answers for a specific proposal (call managers only).
Path parameters:
  - proposal_uuid — UUID of the proposal
  - uuid
Query parameters (10):
  - customer
  - customer_keyword
  - customer_uuid
  - has_active_round
  - name
  - o — Ordering
  - offering_uuid
  - offerings_provider_uuid
  - slug — Slug
  - state

### proposal_protected_calls_proposed_assignments_list
GET /api/proposal-protected-calls/{uuid}/proposed-assignments/
Summary: Get proposed reviewer-proposal assignments
Description: Get proposed reviewer-proposal assignments.
Path parameters:
  - uuid
Query parameters (10):
  - customer
  - customer_keyword
  - customer_uuid
  - has_active_round
  - name
  - o — Ordering
  - offering_uuid
  - offerings_provider_uuid
  - slug — Slug
  - state

### proposal_protected_calls_resource_templates_list
GET /api/proposal-protected-calls/{uuid}/resource_templates/
Summary: List resource templates for a call
Description: List resource templates for a call.
Path parameters:
  - uuid

### proposal_protected_calls_resource_templates_set
POST /api/proposal-protected-calls/{uuid}/resource_templates/
Summary: Create resource template for a call
Description: Create resource template for a call.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_resource_templates_retrieve
GET /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid

### proposal_protected_calls_resource_templates_update
PUT /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid
Request body: yes

### proposal_protected_calls_resource_templates_partial_update
PATCH /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid
Request body: yes

### proposal_protected_calls_resource_templates_destroy
DELETE /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid

### proposal_protected_calls_review_proposal_compliance
POST /api/proposal-protected-calls/{uuid}/review_proposal_compliance/
Summary: Mark proposal compliance as reviewed by call manager
Description: Mark proposal compliance as reviewed by call manager.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_reviewer_pool_list
GET /api/proposal-protected-calls/{uuid}/reviewer-pool/
Summary: List reviewer pool members for a call
Description: List reviewer pool members for a call.
Path parameters:
  - uuid

### proposal_protected_calls_invite_reviewers
POST /api/proposal-protected-calls/{uuid}/reviewer-pool/
Summary: Invite reviewers to join the call's reviewer pool
Description: Invite reviewers to join the call's reviewer pool.
Path parameters:
  - uuid
Query parameters (10):
  - customer
  - customer_keyword
  - customer_uuid
  - has_active_round
  - name
  - o — Ordering
  - offering_uuid
  - offerings_provider_uuid
  - slug — Slug
  - state
Request body: yes

### proposal_protected_calls_rounds_bulk_set
POST /api/proposal-protected-calls/{uuid}/rounds-bulk-set/
Summary: Create multiple rounds on a call at a fixed cadence
Description: Create multiple rounds on a call at a fixed cadence. Spacing is controlled by ``cadence`` (monthly/quarterly/biannual/yearly/custom). Each round's ``cutoff_time`` is derived as ``start_time + submission_window_days``. Fixed-date allocation is not supported in bulk mode.
Path parameters:
  - uuid
Query parameters (10):
  - customer
  - customer_keyword
  - customer_uuid
  - has_active_round
  - name
  - o — Ordering
  - offering_uuid
  - offerings_provider_uuid
  - slug — Slug
  - state
Request body: yes

### proposal_protected_calls_rounds_list
GET /api/proposal-protected-calls/{uuid}/rounds/
Summary: List rounds for a call
Description: List rounds for a call.
Path parameters:
  - uuid

### proposal_protected_calls_rounds_set
POST /api/proposal-protected-calls/{uuid}/rounds/
Summary: Create a round for a call
Description: Create a round for a call.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_rounds_retrieve
GET /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid

### proposal_protected_calls_rounds_update
PUT /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid
Request body: yes

### proposal_protected_calls_rounds_partial_update
PATCH /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid
Request body: yes

### proposal_protected_calls_rounds_destroy
DELETE /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid

### proposal_protected_calls_rounds_close
POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/
Path parameters:
  - obj_uuid
  - uuid
Request body: yes

### proposal_protected_calls_send_all_assignments
POST /api/proposal-protected-calls/{uuid}/send-all-assignments/
Summary: Send all draft assignment batches for this call
Description: Send all draft assignment batches for this call.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_send_invitations
POST /api/proposal-protected-calls/{uuid}/send-invitations/
Summary: Send invitations to all confirmed suggestions
Description: Send invitations to all confirmed suggestions.
Path parameters:
  - uuid

### proposal_protected_calls_suggestions_list
GET /api/proposal-protected-calls/{uuid}/suggestions/
Summary: List all reviewer suggestions for this call with affinity scores
Description: List all reviewer suggestions for this call with affinity scores.
Path parameters:
  - uuid
Query parameters (10):
  - customer
  - customer_keyword
  - customer_uuid
  - has_active_round
  - name
  - o — Ordering
  - offering_uuid
  - offerings_provider_uuid
  - slug — Slug
  - state

### proposal_protected_calls_update_user
POST /api/proposal-protected-calls/{uuid}/update_user/
Summary: Update a user's role expiration
Description: Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_workflow_steps_list
GET /api/proposal-protected-calls/{uuid}/workflow_steps/
Summary: List workflow steps for a call
Description: List workflow steps for a call.
Path parameters:
  - uuid

### proposal_protected_calls_workflow_steps_set
POST /api/proposal-protected-calls/{uuid}/workflow_steps/
Summary: Create or update a workflow step for a call
Description: Create or update a workflow step for a call.
Path parameters:
  - uuid
Request body: yes

### proposal_protected_calls_workflow_steps_retrieve
GET /api/proposal-protected-calls/{uuid}/workflow_steps/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid

### proposal_protected_calls_workflow_steps_update
PUT /api/proposal-protected-calls/{uuid}/workflow_steps/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid
Request body: yes

### proposal_protected_calls_workflow_steps_partial_update
PATCH /api/proposal-protected-calls/{uuid}/workflow_steps/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid
Request body: yes

### proposal_protected_calls_workflow_steps_destroy
DELETE /api/proposal-protected-calls/{uuid}/workflow_steps/{obj_uuid}/
Path parameters:
  - obj_uuid
  - uuid

============================================================
## proposal-public-calls  (module: waldur_api_client.api.proposal_public_calls)
============================================================

### proposal_public_calls_list
GET /api/proposal-public-calls/
Query parameters (11):
  - customer
  - customer_keyword
  - customer_uuid
  - field
  - has_active_round
  - name
  - o — Ordering
  - offering_uuid
  - offerings_provider_uuid
  - slug — Slug
  - state

### proposal_public_calls_count
HEAD /api/proposal-public-calls/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (10):
  - customer
  - customer_keyword
  - customer_uuid
  - has_active_round
  - name
  - o — Ordering
  - offering_uuid
  - offerings_provider_uuid
  - slug — Slug
  - state

### proposal_public_calls_retrieve
GET /api/proposal-public-calls/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### proposal_public_calls_check_eligibility_retrieve
GET /api/proposal-public-calls/{uuid}/check_eligibility/
Summary: Check if the current user is eligible to submit proposals to this call
Description: Check if the current user is eligible to submit proposals to this call.
Path parameters:
  - uuid

============================================================
## proposal-requested-offerings  (module: waldur_api_client.api.proposal_requested_offerings)
============================================================

### proposal_requested_offerings_list
GET /api/proposal-requested-offerings/
Query parameters (8):
  - call — Call
  - call_uuid
  - o — Ordering
  - offering — Offering
  - offering_uuid
  - organization_uuid
  - provider_uuid — Provider
  - state

### proposal_requested_offerings_count
HEAD /api/proposal-requested-offerings/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - call — Call
  - call_uuid
  - o — Ordering
  - offering — Offering
  - offering_uuid
  - organization_uuid
  - provider_uuid — Provider
  - state

### proposal_requested_offerings_retrieve
GET /api/proposal-requested-offerings/{uuid}/
Path parameters:
  - uuid

### proposal_requested_offerings_accept
POST /api/proposal-requested-offerings/{uuid}/accept/
Summary: Accept a requested offering
Description: Accept a requested offering.
Path parameters:
  - uuid

### proposal_requested_offerings_cancel
POST /api/proposal-requested-offerings/{uuid}/cancel/
Summary: Cancel a requested offering
Description: Cancel a requested offering.
Path parameters:
  - uuid

============================================================
## proposal-requested-resources  (module: waldur_api_client.api.proposal_requested_resources)
============================================================

### proposal_requested_resources_list
GET /api/proposal-requested-resources/
Query parameters (8):
  - created
  - o — Ordering
  - offering — Offering
  - offering_uuid
  - proposal — Proposal
  - proposal_uuid
  - resource — Resource
  - resource_uuid

### proposal_requested_resources_count
HEAD /api/proposal-requested-resources/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - created
  - o — Ordering
  - offering — Offering
  - offering_uuid
  - proposal — Proposal
  - proposal_uuid
  - resource — Resource
  - resource_uuid

### proposal_requested_resources_retrieve
GET /api/proposal-requested-resources/{uuid}/
Path parameters:
  - uuid

============================================================
## proposal-reviews  (module: waldur_api_client.api.proposal_reviews)
============================================================

### proposal_reviews_list
GET /api/proposal-reviews/
Query parameters (9):
  - call_uuid
  - o — Ordering
  - organization_uuid
  - proposal
  - proposal_name
  - proposal_uuid
  - reviewer_uuid
  - round_uuid
  - state

### proposal_reviews_count
HEAD /api/proposal-reviews/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - call_uuid
  - o — Ordering
  - organization_uuid
  - proposal
  - proposal_name
  - proposal_uuid
  - reviewer_uuid
  - round_uuid
  - state

### proposal_reviews_create
POST /api/proposal-reviews/
Request body: yes

### proposal_reviews_retrieve
GET /api/proposal-reviews/{uuid}/
Path parameters:
  - uuid

### proposal_reviews_update
PUT /api/proposal-reviews/{uuid}/
Path parameters:
  - uuid
Request body: yes

### proposal_reviews_partial_update
PATCH /api/proposal-reviews/{uuid}/
Path parameters:
  - uuid
Request body: yes

### proposal_reviews_destroy
DELETE /api/proposal-reviews/{uuid}/
Path parameters:
  - uuid

### proposal_reviews_reject
POST /api/proposal-reviews/{uuid}/reject/
Summary: Reject a review, changing its state to REJECTED
Description: Reject a review, changing its state to REJECTED.
Path parameters:
  - uuid

### proposal_reviews_submit
POST /api/proposal-reviews/{uuid}/submit/
Summary: Submit a review, changing its state to SUBMITTED
Description: Submit a review, changing its state to SUBMITTED.
Path parameters:
  - uuid
Request body: yes

============================================================
## provider-invoice-items  (module: waldur_api_client.api.provider_invoice_items)
============================================================

### provider_invoice_items_list
GET /api/provider-invoice-items/
Query parameters (6):
  - customer_uuid — Customer UUID
  - invoice_month — Invoice month
  - invoice_year — Invoice year
  - o — Ordering
  - offering_uuid — Offering UUID
  - project_uuid — Project UUID

### provider_invoice_items_count
HEAD /api/provider-invoice-items/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - customer_uuid — Customer UUID
  - invoice_month — Invoice month
  - invoice_year — Invoice year
  - o — Ordering
  - offering_uuid — Offering UUID
  - project_uuid — Project UUID

### provider_invoice_items_retrieve
GET /api/provider-invoice-items/{id}/
Path parameters:
  - id — A unique integer value identifying this invoice item.

============================================================
## public-maintenance-announcements  (module: waldur_api_client.api.public_maintenance_announcements)
============================================================

### public_maintenance_announcements_list
GET /api/public-maintenance-announcements/
Summary: List public maintenance announcements
Description: Returns a paginated list of public maintenance announcements. Only announcements that are 'Scheduled', 'In progress', or 'Completed' are visible. This endpoint is accessible to unauthenticated users.
Query parameters (9):
  - maintenance_type — Maintenance type
  - o — Ordering
  - scheduled_end_after — Scheduled end after
  - scheduled_end_before — Scheduled end before
  - scheduled_start_after — Scheduled start after
  - scheduled_start_before — Scheduled start before
  - service_provider_uuid — Service provider UUID
  - state — Maintenance state
  - timing_bucket — Timing bucket (comma-separated: on_time, late_start, overrun, early, pending)

### public_maintenance_announcements_count
HEAD /api/public-maintenance-announcements/
Summary: List public maintenance announcements
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - maintenance_type — Maintenance type
  - o — Ordering
  - scheduled_end_after — Scheduled end after
  - scheduled_end_before — Scheduled end before
  - scheduled_start_after — Scheduled start after
  - scheduled_start_before — Scheduled start before
  - service_provider_uuid — Service provider UUID
  - state — Maintenance state
  - timing_bucket — Timing bucket (comma-separated: on_time, late_start, overrun, early, pending)

### public_maintenance_announcements_retrieve
GET /api/public-maintenance-announcements/{uuid}/
Summary: Retrieve a public maintenance announcement
Description: Returns the details of a specific public maintenance announcement.
Path parameters:
  - uuid

============================================================
## query  (module: waldur_api_client.api.query)
============================================================

### query
POST /api/query/
Summary: Execute read-only SQL query
Description: Execute a given SQL query against a read-only database replica. This is a powerful tool for diagnostics and reporting, but should be used with caution. Requires staff user permissions.
Request body: yes

============================================================
## rabbitmq-overview  (module: waldur_api_client.api.rabbitmq_overview)
============================================================

### rabbitmq_overview_retrieve
GET /api/rabbitmq-overview/
Summary: Get RabbitMQ cluster overview statistics
Description: Returns global RabbitMQ cluster health and performance metrics.

Includes:
- **Cluster info**: Name, RabbitMQ version, Erlang version
- **Message stats**: Publish/deliver/confirm/ack counts and rates (per second)
- **Queue totals**: Total messages, ready messages, unacknowledged messages
- **Obje...

============================================================
## rabbitmq-stats  (module: waldur_api_client.api.rabbitmq_stats)
============================================================

### rabbitmq_stats_retrieve
GET /api/rabbitmq-stats/
Summary: Get RabbitMQ subscription queue statistics
Description: Provides statistics about RabbitMQ subscription queues.

Returns information about all vhosts with their subscription queues, including:
- Queue names and message counts
- Waldur user and subscription information linked to each vhost
- Total message counts per vhost and across all vhosts

Require...

### rabbitmq_stats
POST /api/rabbitmq-stats/
Summary: Purge or delete RabbitMQ subscription queues
Description: Purges messages from or deletes specified RabbitMQ subscription queues.

**Purge operations** (remove messages, keep queue):
- `vhost` and `queue_name`: Purge a specific queue
- `vhost` and `queue_pattern`: Purge queues matching pattern (e.g., '*_resource')
- `purge_all_subscription_queues`: Purg...
Request body: yes

============================================================
## rabbitmq-user-stats  (module: waldur_api_client.api.rabbitmq_user_stats)
============================================================

### rabbitmq_user_stats_list
GET /api/rabbitmq-user-stats/
Summary: Get RabbitMQ user connection statistics
Description: Returns enriched connection data for all RabbitMQ users.

For each user (which corresponds to an EventSubscription), provides:
- Connection state (running, blocked, blocking)
- Traffic statistics (bytes sent/received)
- Connection timestamp
- Client properties (product, version, platform)
- Chann...

============================================================
## rabbitmq-vhost-stats  (module: waldur_api_client.api.rabbitmq_vhost_stats)
============================================================

### rabbitmq_vhost_stats_list
GET /api/rabbitmq-vhost-stats/

============================================================
## rancher-apps  (module: waldur_api_client.api.rancher_apps)
============================================================

### rancher_apps_list
GET /api/rancher-apps/
Query parameters (21):
  - backend_id — Backend ID
  - can_manage — Can manage
  - cluster_uuid
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - namespace_uuid
  - project — Project UUID
  - project_name — Project name
  - project_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - template_uuid

### rancher_apps_count
HEAD /api/rancher-apps/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (20):
  - backend_id — Backend ID
  - can_manage — Can manage
  - cluster_uuid
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - namespace_uuid
  - project — Project UUID
  - project_name — Project name
  - project_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - template_uuid

### rancher_apps_create
POST /api/rancher-apps/
Request body: yes

### rancher_apps_retrieve
GET /api/rancher-apps/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### rancher_apps_update
PUT /api/rancher-apps/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_apps_partial_update
PATCH /api/rancher-apps/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_apps_destroy
DELETE /api/rancher-apps/{uuid}/
Path parameters:
  - uuid

### rancher_apps_pull
POST /api/rancher-apps/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### rancher_apps_set_erred
POST /api/rancher-apps/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### rancher_apps_set_ok
POST /api/rancher-apps/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### rancher_apps_unlink
POST /api/rancher-apps/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## rancher-catalogs  (module: waldur_api_client.api.rancher_catalogs)
============================================================

### rancher_catalogs_list
GET /api/rancher-catalogs/

### rancher_catalogs_count
HEAD /api/rancher-catalogs/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### rancher_catalogs_create
POST /api/rancher-catalogs/
Request body: yes

### rancher_catalogs_retrieve
GET /api/rancher-catalogs/{uuid}/
Path parameters:
  - uuid

### rancher_catalogs_update
PUT /api/rancher-catalogs/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_catalogs_partial_update
PATCH /api/rancher-catalogs/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_catalogs_destroy
DELETE /api/rancher-catalogs/{uuid}/
Path parameters:
  - uuid

### rancher_catalogs_refresh
POST /api/rancher-catalogs/{uuid}/refresh/
Path parameters:
  - uuid

============================================================
## rancher-cluster-security-groups  (module: waldur_api_client.api.rancher_cluster_security_groups)
============================================================

### rancher_cluster_security_groups_list
GET /api/rancher-cluster-security-groups/
Query parameters (3):
  - cluster_uuid
  - name — Name
  - name_exact — Name (exact)

### rancher_cluster_security_groups_count
HEAD /api/rancher-cluster-security-groups/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - cluster_uuid
  - name — Name
  - name_exact — Name (exact)

### rancher_cluster_security_groups_retrieve
GET /api/rancher-cluster-security-groups/{uuid}/
Path parameters:
  - uuid

### rancher_cluster_security_groups_update
PUT /api/rancher-cluster-security-groups/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_cluster_security_groups_partial_update
PATCH /api/rancher-cluster-security-groups/{uuid}/
Path parameters:
  - uuid
Request body: yes

============================================================
## rancher-cluster-templates  (module: waldur_api_client.api.rancher_cluster_templates)
============================================================

### rancher_cluster_templates_list
GET /api/rancher-cluster-templates/

### rancher_cluster_templates_count
HEAD /api/rancher-cluster-templates/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### rancher_cluster_templates_retrieve
GET /api/rancher-cluster-templates/{uuid}/
Path parameters:
  - uuid

============================================================
## rancher-clusters  (module: waldur_api_client.api.rancher_clusters)
============================================================

### rancher_clusters_list
GET /api/rancher-clusters/
Query parameters (18):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### rancher_clusters_count
HEAD /api/rancher-clusters/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (17):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### rancher_clusters_retrieve
GET /api/rancher-clusters/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### rancher_clusters_update
PUT /api/rancher-clusters/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_clusters_partial_update
PATCH /api/rancher-clusters/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_clusters_create_management_security_group
POST /api/rancher-clusters/{uuid}/create_management_security_group/
Path parameters:
  - uuid
Request body: yes

### rancher_clusters_import_yaml
POST /api/rancher-clusters/{uuid}/import_yaml/
Path parameters:
  - uuid
Request body: yes

### rancher_clusters_pull
POST /api/rancher-clusters/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### rancher_clusters_set_erred
POST /api/rancher-clusters/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### rancher_clusters_set_ok
POST /api/rancher-clusters/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### rancher_clusters_unlink
POST /api/rancher-clusters/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## rancher-hpas  (module: waldur_api_client.api.rancher_hpas)
============================================================

### rancher_hpas_list
GET /api/rancher-hpas/
Query parameters (8):
  - cluster_uuid
  - name — Name
  - name_exact — Name (exact)
  - namespace_uuid
  - project_uuid
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - workload_uuid

### rancher_hpas_count
HEAD /api/rancher-hpas/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - cluster_uuid
  - name — Name
  - name_exact — Name (exact)
  - namespace_uuid
  - project_uuid
  - settings — Settings URL
  - settings_uuid — Settings UUID
  - workload_uuid

### rancher_hpas_create
POST /api/rancher-hpas/
Request body: yes

### rancher_hpas_retrieve
GET /api/rancher-hpas/{uuid}/
Path parameters:
  - uuid

### rancher_hpas_update
PUT /api/rancher-hpas/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_hpas_partial_update
PATCH /api/rancher-hpas/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_hpas_destroy
DELETE /api/rancher-hpas/{uuid}/
Path parameters:
  - uuid

### rancher_hpas_pull
POST /api/rancher-hpas/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### rancher_hpas_set_erred
POST /api/rancher-hpas/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### rancher_hpas_set_ok
POST /api/rancher-hpas/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### rancher_hpas_unlink
POST /api/rancher-hpas/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

### rancher_hpas_yaml_retrieve
GET /api/rancher-hpas/{uuid}/yaml/
Path parameters:
  - uuid

### rancher_hpas_yaml_update
PUT /api/rancher-hpas/{uuid}/yaml/
Path parameters:
  - uuid
Request body: yes

============================================================
## rancher-ingresses  (module: waldur_api_client.api.rancher_ingresses)
============================================================

### rancher_ingresses_list
GET /api/rancher-ingresses/
Query parameters (21):
  - backend_id — Backend ID
  - can_manage — Can manage
  - cluster_uuid
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - namespace_uuid
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - rancher_project_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### rancher_ingresses_count
HEAD /api/rancher-ingresses/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (20):
  - backend_id — Backend ID
  - can_manage — Can manage
  - cluster_uuid
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - namespace_uuid
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - rancher_project_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### rancher_ingresses_create
POST /api/rancher-ingresses/
Request body: yes

### rancher_ingresses_retrieve
GET /api/rancher-ingresses/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### rancher_ingresses_update
PUT /api/rancher-ingresses/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_ingresses_partial_update
PATCH /api/rancher-ingresses/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_ingresses_destroy
DELETE /api/rancher-ingresses/{uuid}/
Path parameters:
  - uuid

### rancher_ingresses_pull
POST /api/rancher-ingresses/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### rancher_ingresses_set_erred
POST /api/rancher-ingresses/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### rancher_ingresses_set_ok
POST /api/rancher-ingresses/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### rancher_ingresses_unlink
POST /api/rancher-ingresses/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

### rancher_ingresses_yaml_retrieve
GET /api/rancher-ingresses/{uuid}/yaml/
Path parameters:
  - uuid

### rancher_ingresses_yaml_update
PUT /api/rancher-ingresses/{uuid}/yaml/
Path parameters:
  - uuid
Request body: yes

============================================================
## rancher-namespaces  (module: waldur_api_client.api.rancher_namespaces)
============================================================

### rancher_namespaces_list
GET /api/rancher-namespaces/
Query parameters (7):
  - cluster_uuid
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - project_uuid
  - settings — Settings URL
  - settings_uuid — Settings UUID

### rancher_namespaces_count
HEAD /api/rancher-namespaces/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (7):
  - cluster_uuid
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - project_uuid
  - settings — Settings URL
  - settings_uuid — Settings UUID

### rancher_namespaces_retrieve
GET /api/rancher-namespaces/{uuid}/
Path parameters:
  - uuid

============================================================
## rancher-nodes  (module: waldur_api_client.api.rancher_nodes)
============================================================

### rancher_nodes_list
GET /api/rancher-nodes/
Query parameters (1):
  - cluster_uuid

### rancher_nodes_count
HEAD /api/rancher-nodes/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - cluster_uuid

### rancher_nodes_create
POST /api/rancher-nodes/
Request body: yes

### rancher_nodes_retrieve
GET /api/rancher-nodes/{uuid}/
Path parameters:
  - uuid

### rancher_nodes_destroy
DELETE /api/rancher-nodes/{uuid}/
Path parameters:
  - uuid

### rancher_nodes_console_retrieve
GET /api/rancher-nodes/{uuid}/console/
Summary: Returns console URL for the node
Description: Returns console URL for the node.
Path parameters:
  - uuid

### rancher_nodes_console_log_retrieve
GET /api/rancher-nodes/{uuid}/console_log/
Summary: Returns console log for the node
Description: Returns console log for the node.
Path parameters:
  - uuid
Query parameters (1):
  - length

### rancher_nodes_link_openstack
POST /api/rancher-nodes/{uuid}/link_openstack/
Summary: Links node to OpenStack instance
Description: Links node to OpenStack instance.
Path parameters:
  - uuid
Request body: yes

### rancher_nodes_pull
POST /api/rancher-nodes/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### rancher_nodes_set_erred
POST /api/rancher-nodes/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### rancher_nodes_set_ok
POST /api/rancher-nodes/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### rancher_nodes_unlink
POST /api/rancher-nodes/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

### rancher_nodes_unlink_openstack
POST /api/rancher-nodes/{uuid}/unlink_openstack/
Summary: Unlinks node from OpenStack instance
Description: Unlinks node from OpenStack instance.
Path parameters:
  - uuid

============================================================
## rancher-projects  (module: waldur_api_client.api.rancher_projects)
============================================================

### rancher_projects_list
GET /api/rancher-projects/
Query parameters (5):
  - cluster_uuid
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### rancher_projects_count
HEAD /api/rancher-projects/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - cluster_uuid
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### rancher_projects_retrieve
GET /api/rancher-projects/{uuid}/
Path parameters:
  - uuid

### rancher_projects_secrets_list
GET /api/rancher-projects/{uuid}/secrets/
Summary: Returns project's secrets
Description: Returns project's secrets.
Path parameters:
  - uuid

============================================================
## rancher-role-templates  (module: waldur_api_client.api.rancher_role_templates)
============================================================

### rancher_role_templates_list
GET /api/rancher-role-templates/
Query parameters (4):
  - name
  - o — Ordering
  - scope_type
  - settings_uuid

### rancher_role_templates_count
HEAD /api/rancher-role-templates/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - name
  - o — Ordering
  - scope_type
  - settings_uuid

### rancher_role_templates_retrieve
GET /api/rancher-role-templates/{uuid}/
Path parameters:
  - uuid

============================================================
## rancher-services  (module: waldur_api_client.api.rancher_services)
============================================================

### rancher_services_list
GET /api/rancher-services/
Query parameters (21):
  - backend_id — Backend ID
  - can_manage — Can manage
  - cluster_uuid
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - namespace_uuid
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - rancher_project_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### rancher_services_count
HEAD /api/rancher-services/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (20):
  - backend_id — Backend ID
  - can_manage — Can manage
  - cluster_uuid
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - namespace_uuid
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - rancher_project_uuid
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### rancher_services_create
POST /api/rancher-services/
Request body: yes

### rancher_services_retrieve
GET /api/rancher-services/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### rancher_services_update
PUT /api/rancher-services/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_services_partial_update
PATCH /api/rancher-services/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_services_destroy
DELETE /api/rancher-services/{uuid}/
Path parameters:
  - uuid

### rancher_services_pull
POST /api/rancher-services/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### rancher_services_set_erred
POST /api/rancher-services/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### rancher_services_set_ok
POST /api/rancher-services/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### rancher_services_unlink
POST /api/rancher-services/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

### rancher_services_yaml_retrieve
GET /api/rancher-services/{uuid}/yaml/
Path parameters:
  - uuid

### rancher_services_yaml_update
PUT /api/rancher-services/{uuid}/yaml/
Path parameters:
  - uuid
Request body: yes

============================================================
## rancher-template-versions  (module: waldur_api_client.api.rancher_template_versions)
============================================================

### rancher_template_versions_retrieve
GET /api/rancher-template-versions/{template_uuid}/{version}/
Path parameters:
  - template_uuid
  - version

============================================================
## rancher-templates  (module: waldur_api_client.api.rancher_templates)
============================================================

### rancher_templates_list
GET /api/rancher-templates/
Query parameters (8):
  - catalog_uuid
  - cluster_uuid
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - project_uuid
  - settings — Settings URL
  - settings_uuid — Settings UUID

### rancher_templates_count
HEAD /api/rancher-templates/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - catalog_uuid
  - cluster_uuid
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering
  - project_uuid
  - settings — Settings URL
  - settings_uuid — Settings UUID

### rancher_templates_retrieve
GET /api/rancher-templates/{uuid}/
Path parameters:
  - uuid

============================================================
## rancher-users  (module: waldur_api_client.api.rancher_users)
============================================================

### rancher_users_list
GET /api/rancher-users/
Query parameters (6):
  - cluster_uuid — Cluster UUID
  - is_active
  - settings_uuid
  - user_full_name — User full name contains
  - user_username
  - user_uuid

### rancher_users_count
HEAD /api/rancher-users/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - cluster_uuid — Cluster UUID
  - is_active
  - settings_uuid
  - user_full_name — User full name contains
  - user_username
  - user_uuid

### rancher_users_retrieve
GET /api/rancher-users/{uuid}/
Path parameters:
  - uuid

============================================================
## rancher-workloads  (module: waldur_api_client.api.rancher_workloads)
============================================================

### rancher_workloads_list
GET /api/rancher-workloads/
Query parameters (8):
  - cluster_uuid
  - name — Name
  - name_exact — Name (exact)
  - namespace_uuid
  - o — Ordering
  - project_uuid
  - settings — Settings URL
  - settings_uuid — Settings UUID

### rancher_workloads_count
HEAD /api/rancher-workloads/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - cluster_uuid
  - name — Name
  - name_exact — Name (exact)
  - namespace_uuid
  - o — Ordering
  - project_uuid
  - settings — Settings URL
  - settings_uuid — Settings UUID

### rancher_workloads_create
POST /api/rancher-workloads/
Request body: yes

### rancher_workloads_retrieve
GET /api/rancher-workloads/{uuid}/
Path parameters:
  - uuid

### rancher_workloads_update
PUT /api/rancher-workloads/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_workloads_partial_update
PATCH /api/rancher-workloads/{uuid}/
Path parameters:
  - uuid
Request body: yes

### rancher_workloads_destroy
DELETE /api/rancher-workloads/{uuid}/
Path parameters:
  - uuid

### rancher_workloads_redeploy
POST /api/rancher-workloads/{uuid}/redeploy/
Path parameters:
  - uuid

### rancher_workloads_yaml_retrieve
GET /api/rancher-workloads/{uuid}/yaml/
Path parameters:
  - uuid

### rancher_workloads_yaml_update
PUT /api/rancher-workloads/{uuid}/yaml/
Path parameters:
  - uuid
Request body: yes

============================================================
## remote-eduteams  (module: waldur_api_client.api.remote_eduteams)
============================================================

### remote_eduteams
POST /api/remote-eduteams/
Summary: Allows to pull user details from remote eduTEAMS instance
Description: Allows to pull user details from remote eduTEAMS instance.
Request body: yes

============================================================
## remote-waldur-api  (module: waldur_api_client.api.remote_waldur_api)
============================================================

### remote_waldur_api_cancel_termination
POST /api/remote-waldur-api/cancel_termination/{uuid}
Summary: Cancel termination order
Path parameters:
  - uuid

### remote_waldur_api_import_offering
POST /api/remote-waldur-api/import_offering/
Summary: Create local offering from remote
Request body: yes

### remote_waldur_api_pull_offering_details
POST /api/remote-waldur-api/pull_offering_details/{uuid}/
Path parameters:
  - uuid

### remote_waldur_api_pull_offering_orders
POST /api/remote-waldur-api/pull_offering_orders/{uuid}/
Path parameters:
  - uuid

### remote_waldur_api_pull_offering_resources
POST /api/remote-waldur-api/pull_offering_resources/{uuid}/
Path parameters:
  - uuid

### remote_waldur_api_pull_offering_robot_accounts
POST /api/remote-waldur-api/pull_offering_robot_accounts/{uuid}/
Path parameters:
  - uuid

### remote_waldur_api_pull_offering_usage
POST /api/remote-waldur-api/pull_offering_usage/{uuid}/
Path parameters:
  - uuid

### remote_waldur_api_pull_offering_users
POST /api/remote-waldur-api/pull_offering_users/{uuid}/
Path parameters:
  - uuid

### remote_waldur_api_pull_order
POST /api/remote-waldur-api/pull_order/{uuid}
Summary: Schedule order pull task
Path parameters:
  - uuid

### remote_waldur_api_pull_resource_robot_accounts
POST /api/remote-waldur-api/pull_resource_robot_accounts/{uuid}/
Path parameters:
  - uuid

### remote_waldur_api_push_project_data
POST /api/remote-waldur-api/push_project_data/{uuid}/
Path parameters:
  - uuid

### remote_waldur_api_remote_categories
POST /api/remote-waldur-api/remote_categories/
Summary: List remote marketplace categories
Request body: yes

### remote_waldur_api_remote_customers
POST /api/remote-waldur-api/remote_customers/
Summary: List remote customers owned by current user
Request body: yes

### remote_waldur_api_remote_resource_order_status_retrieve
GET /api/remote-waldur-api/remote_resource_order_status/{resource_uuid}/
Summary: Get remote order details
Path parameters:
  - resource_uuid

### remote_waldur_api_remote_resource_status_retrieve
GET /api/remote-waldur-api/remote_resource_status/{resource_uuid}/
Summary: Get remote resource sync status
Path parameters:
  - resource_uuid

### remote_waldur_api_remote_resource_team_status_list
GET /api/remote-waldur-api/remote_resource_team_status/{resource_uuid}/
Summary: Get remote resource team members
Path parameters:
  - resource_uuid

### remote_waldur_api_shared_offerings
POST /api/remote-waldur-api/shared_offerings/
Summary: List remote importable offerings for particular customer
Query parameters (1):
  - customer_uuid
Request body: yes

### remote_waldur_api_sync_resource
POST /api/remote-waldur-api/sync_resource/{uuid}/
Path parameters:
  - uuid

### remote_waldur_api_sync_resource_project_permissions
POST /api/remote-waldur-api/sync_resource_project_permissions/{uuid}/
Path parameters:
  - uuid

============================================================
## reviewer-bids  (module: waldur_api_client.api.reviewer_bids)
============================================================

### reviewer_bids_list
GET /api/reviewer-bids/
Query parameters (5):
  - bid — Reviewer's preference for reviewing this proposal
  - call_uuid
  - o — Ordering
  - proposal_uuid
  - reviewer_uuid

### reviewer_bids_count
HEAD /api/reviewer-bids/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - bid — Reviewer's preference for reviewing this proposal
  - call_uuid
  - o — Ordering
  - proposal_uuid
  - reviewer_uuid

### reviewer_bids_create
POST /api/reviewer-bids/
Request body: yes

### reviewer_bids_bulk_submit
POST /api/reviewer-bids/bulk-submit/
Summary: Submit multiple bids at once
Description: Submit multiple bids at once.
Request body: yes

### reviewer_bids_my_bids_list
GET /api/reviewer-bids/my-bids/
Summary: Get my bids for a specific call
Description: Get my bids for a specific call.
Query parameters (5):
  - bid — Reviewer's preference for reviewing this proposal
  - call_uuid
  - o — Ordering
  - proposal_uuid
  - reviewer_uuid

### reviewer_bids_my_bids_count
HEAD /api/reviewer-bids/my-bids/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - bid — Reviewer's preference for reviewing this proposal
  - call_uuid
  - o — Ordering
  - proposal_uuid
  - reviewer_uuid

### reviewer_bids_submit
POST /api/reviewer-bids/submit/
Summary: Submit a bid on a proposal
Description: Submit a bid on a proposal.
Request body: yes

### reviewer_bids_retrieve
GET /api/reviewer-bids/{uuid}/
Path parameters:
  - uuid

### reviewer_bids_update
PUT /api/reviewer-bids/{uuid}/
Path parameters:
  - uuid
Request body: yes

### reviewer_bids_partial_update
PATCH /api/reviewer-bids/{uuid}/
Path parameters:
  - uuid
Request body: yes

### reviewer_bids_destroy
DELETE /api/reviewer-bids/{uuid}/
Path parameters:
  - uuid

============================================================
## reviewer-invitations  (module: waldur_api_client.api.reviewer_invitations)
============================================================

### reviewer_invitations_retrieve
GET /api/reviewer-invitations/{token}/
Summary: Get invitation details by token
Description: Get invitation details by token.
Path parameters:
  - token

### reviewer_invitations_accept
POST /api/reviewer-invitations/{token}/accept/
Summary: Accept a reviewer invitation
Description: Accept a reviewer invitation.
Path parameters:
  - token
Request body: yes

### reviewer_invitations_decline
POST /api/reviewer-invitations/{token}/decline/
Summary: Decline a reviewer invitation
Description: Decline a reviewer invitation.
Path parameters:
  - token
Request body: yes

============================================================
## reviewer-profiles  (module: waldur_api_client.api.reviewer_profiles)
============================================================

### reviewer_profiles_list
GET /api/reviewer-profiles/
Query parameters (8):
  - expertise_category_uuid
  - expertise_keyword
  - has_orcid
  - o — Ordering
  - orcid_id
  - user_email
  - user_name
  - user_uuid

### reviewer_profiles_count
HEAD /api/reviewer-profiles/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - expertise_category_uuid
  - expertise_keyword
  - has_orcid
  - o — Ordering
  - orcid_id
  - user_email
  - user_name
  - user_uuid

### reviewer_profiles_create
POST /api/reviewer-profiles/
Request body: yes

### reviewer_profiles_me_retrieve
GET /api/reviewer-profiles/me/
Summary: Get or create reviewer profile for the current user
Description: Get or create reviewer profile for the current user.

### reviewer_profiles_me_count
HEAD /api/reviewer-profiles/me/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### reviewer_profiles_me
POST /api/reviewer-profiles/me/
Summary: Get or create reviewer profile for the current user
Description: Get or create reviewer profile for the current user.
Request body: yes

### reviewer_profiles_me_partial_update
PATCH /api/reviewer-profiles/me/
Summary: Get or create reviewer profile for the current user
Description: Get or create reviewer profile for the current user.
Request body: yes

### reviewer_profiles_publish
POST /api/reviewer-profiles/publish/
Summary: Publish reviewer profile for discovery by call managers
Description: Publish reviewer profile for discovery by call managers. Warning: Publishing makes your full profile visible to call managers globally.
Request body: yes

### reviewer_profiles_unpublish
POST /api/reviewer-profiles/unpublish/
Summary: Unpublish reviewer profile to remove it from discovery
Description: Unpublish reviewer profile to remove it from discovery.
Request body: yes

### nested_reviewer_profile_affiliations_list
GET /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile

### nested_reviewer_profile_affiliations_count
HEAD /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile

### nested_reviewer_profile_affiliations_create
POST /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
Request body: yes

### nested_reviewer_profile_affiliations_retrieve
GET /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/{uuid}/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
  - uuid

### nested_reviewer_profile_affiliations_update
PUT /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/{uuid}/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
  - uuid
Request body: yes

### nested_reviewer_profile_affiliations_partial_update
PATCH /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/{uuid}/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
  - uuid
Request body: yes

### nested_reviewer_profile_affiliations_destroy
DELETE /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/{uuid}/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
  - uuid

### nested_reviewer_profile_expertise_list
GET /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile

### nested_reviewer_profile_expertise_count
HEAD /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile

### nested_reviewer_profile_expertise_create
POST /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
Request body: yes

### nested_reviewer_profile_expertise_retrieve
GET /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/{uuid}/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
  - uuid

### nested_reviewer_profile_expertise_update
PUT /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/{uuid}/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
  - uuid
Request body: yes

### nested_reviewer_profile_expertise_partial_update
PATCH /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/{uuid}/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
  - uuid
Request body: yes

### nested_reviewer_profile_expertise_destroy
DELETE /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/{uuid}/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
  - uuid

### nested_reviewer_profile_publications_list
GET /api/reviewer-profiles/{reviewer_profile_uuid}/publications/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile

### nested_reviewer_profile_publications_count
HEAD /api/reviewer-profiles/{reviewer_profile_uuid}/publications/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile

### nested_reviewer_profile_publications_create
POST /api/reviewer-profiles/{reviewer_profile_uuid}/publications/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
Request body: yes

### nested_reviewer_profile_publications_retrieve
GET /api/reviewer-profiles/{reviewer_profile_uuid}/publications/{uuid}/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
  - uuid

### nested_reviewer_profile_publications_update
PUT /api/reviewer-profiles/{reviewer_profile_uuid}/publications/{uuid}/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
  - uuid
Request body: yes

### nested_reviewer_profile_publications_partial_update
PATCH /api/reviewer-profiles/{reviewer_profile_uuid}/publications/{uuid}/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
  - uuid
Request body: yes

### nested_reviewer_profile_publications_destroy
DELETE /api/reviewer-profiles/{reviewer_profile_uuid}/publications/{uuid}/
Path parameters:
  - reviewer_profile_uuid — UUID of the parent reviewer profile
  - uuid

### reviewer_profiles_retrieve
GET /api/reviewer-profiles/{uuid}/
Path parameters:
  - uuid

### reviewer_profiles_update
PUT /api/reviewer-profiles/{uuid}/
Path parameters:
  - uuid
Request body: yes

### reviewer_profiles_partial_update
PATCH /api/reviewer-profiles/{uuid}/
Path parameters:
  - uuid
Request body: yes

### reviewer_profiles_destroy
DELETE /api/reviewer-profiles/{uuid}/
Path parameters:
  - uuid

### reviewer_profiles_connect_orcid_retrieve
GET /api/reviewer-profiles/{uuid}/connect-orcid/
Summary: Get ORCID OAuth authorization URL
Description: Get ORCID OAuth authorization URL.
Path parameters:
  - uuid

### reviewer_profiles_connect_orcid_callback
POST /api/reviewer-profiles/{uuid}/connect-orcid/callback/
Summary: Complete ORCID OAuth connection with authorization code
Description: Complete ORCID OAuth connection with authorization code.
Path parameters:
  - uuid
Request body: yes

### reviewer_profiles_disconnect_orcid
POST /api/reviewer-profiles/{uuid}/disconnect-orcid/
Summary: Disconnect ORCID from profile
Description: Disconnect ORCID from profile.
Path parameters:
  - uuid
Request body: yes

### reviewer_profiles_import_publications
POST /api/reviewer-profiles/{uuid}/import-publications/
Summary: Import publications from ORCID or other sources
Description: Import publications from ORCID or other sources.
Path parameters:
  - uuid
Request body: yes

### reviewer_profiles_sync_orcid
POST /api/reviewer-profiles/{uuid}/sync-orcid/
Summary: Sync profile data from ORCID
Description: Sync profile data from ORCID.
Path parameters:
  - uuid
Request body: yes

============================================================
## reviewer-suggestions  (module: waldur_api_client.api.reviewer_suggestions)
============================================================

### reviewer_suggestions_list
GET /api/reviewer-suggestions/
Query parameters (5):
  - call_uuid
  - min_affinity_score
  - o — Ordering
  - reviewer_uuid
  - status

### reviewer_suggestions_count
HEAD /api/reviewer-suggestions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - call_uuid
  - min_affinity_score
  - o — Ordering
  - reviewer_uuid
  - status

### reviewer_suggestions_retrieve
GET /api/reviewer-suggestions/{uuid}/
Path parameters:
  - uuid

### reviewer_suggestions_destroy
DELETE /api/reviewer-suggestions/{uuid}/
Summary: Delete a reviewer suggestion
Description: Delete a reviewer suggestion.
Path parameters:
  - uuid

### reviewer_suggestions_confirm
POST /api/reviewer-suggestions/{uuid}/confirm/
Summary: Confirm a reviewer suggestion
Description: Confirm a reviewer suggestion. The reviewer will be invited to the call.
Path parameters:
  - uuid
Request body: yes

### reviewer_suggestions_reject
POST /api/reviewer-suggestions/{uuid}/reject/
Summary: Reject a reviewer suggestion
Description: Reject a reviewer suggestion.
Path parameters:
  - uuid
Request body: yes

============================================================
## role-availabilities  (module: waldur_api_client.api.role_availabilities)
============================================================

### role_availabilities_list
GET /api/role-availabilities/
Query parameters (4):
  - object_id — Scope object id
  - role_name — Role name contains
  - role_uuid — Role UUID
  - scope_type — Scope content type (e.g. 'offering', 'customer')

### role_availabilities_count
HEAD /api/role-availabilities/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - object_id — Scope object id
  - role_name — Role name contains
  - role_uuid — Role UUID
  - scope_type — Scope content type (e.g. 'offering', 'customer')

### role_availabilities_retrieve
GET /api/role-availabilities/{uuid}/
Path parameters:
  - uuid

### role_availabilities_destroy
DELETE /api/role-availabilities/{uuid}/
Path parameters:
  - uuid

============================================================
## roles  (module: waldur_api_client.api.roles)
============================================================

### roles_list
GET /api/roles/
Summary: List roles
Description: Get a list of all available roles.
Query parameters (4):
  - description
  - field
  - is_active
  - name

### roles_count
HEAD /api/roles/
Summary: List roles
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - description
  - is_active
  - name

### roles_create
POST /api/roles/
Summary: Create a new role
Description: Allows staff users to create a new custom role with a specific set of permissions.
Request body: yes

### roles_retrieve
GET /api/roles/{uuid}/
Summary: Get role details
Description: Retrieve the details of a specific role by its UUID.
Path parameters:
  - uuid
Query parameters (1):
  - field

### roles_update
PUT /api/roles/{uuid}/
Summary: Update a role
Description: Allows staff users to update an existing role's name, description, content type, and permissions. The name of a system role cannot be changed.
Path parameters:
  - uuid
Request body: yes

### roles_partial_update
PATCH /api/roles/{uuid}/
Path parameters:
  - uuid
Request body: yes

### roles_destroy
DELETE /api/roles/{uuid}/
Summary: Delete a role
Description: Allows staff users to delete a custom role. System roles and roles that are currently in use cannot be deleted.
Path parameters:
  - uuid

### roles_disable
POST /api/roles/{uuid}/disable/
Summary: Disable a role
Description: Allows staff users to disable a role, preventing it from being assigned further. Existing assignments are not affected.
Path parameters:
  - uuid

### roles_enable
POST /api/roles/{uuid}/enable/
Summary: Enable a role
Description: Allows staff users to enable a role, making it available for assignment.
Path parameters:
  - uuid

### roles_update_descriptions_update
PUT /api/roles/{uuid}/update_descriptions/
Summary: Update role descriptions
Description: Allows staff users to update the multilingual descriptions of a role.
Path parameters:
  - uuid
Request body: yes

============================================================
## science-domains  (module: waldur_api_client.api.science_domains)
============================================================

### science_domains_list
GET /api/science-domains/
Query parameters (3):
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering

### science_domains_count
HEAD /api/science-domains/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering

### science_domains_create
POST /api/science-domains/
Request body: yes

### science_domains_load_preset
POST /api/science-domains/load_preset/
Summary: Load a science domain preset
Request body: yes

### science_domains_presets_list
GET /api/science-domains/presets/
Summary: List available science domain presets
Query parameters (3):
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering

### science_domains_presets_count
HEAD /api/science-domains/presets/
Summary: List available science domain presets
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering

### science_domains_retrieve
GET /api/science-domains/{uuid}/
Path parameters:
  - uuid

### science_domains_update
PUT /api/science-domains/{uuid}/
Path parameters:
  - uuid
Request body: yes

### science_domains_partial_update
PATCH /api/science-domains/{uuid}/
Path parameters:
  - uuid
Request body: yes

### science_domains_destroy
DELETE /api/science-domains/{uuid}/
Path parameters:
  - uuid

============================================================
## science-sub-domains  (module: waldur_api_client.api.science_sub_domains)
============================================================

### science_sub_domains_list
GET /api/science-sub-domains/
Query parameters (5):
  - domain_name — Domain name
  - domain_uuid — Domain UUID
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering

### science_sub_domains_count
HEAD /api/science-sub-domains/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - domain_name — Domain name
  - domain_uuid — Domain UUID
  - name — Name
  - name_exact — Name (exact)
  - o — Ordering

### science_sub_domains_create
POST /api/science-sub-domains/
Request body: yes

### science_sub_domains_retrieve
GET /api/science-sub-domains/{uuid}/
Path parameters:
  - uuid

### science_sub_domains_update
PUT /api/science-sub-domains/{uuid}/
Path parameters:
  - uuid
Request body: yes

### science_sub_domains_partial_update
PATCH /api/science-sub-domains/{uuid}/
Path parameters:
  - uuid
Request body: yes

### science_sub_domains_destroy
DELETE /api/science-sub-domains/{uuid}/
Path parameters:
  - uuid

============================================================
## service-settings  (module: waldur_api_client.api.service_settings)
============================================================

### service_settings_list
GET /api/service-settings/
Query parameters (11):
  - customer — Customer UUID
  - customer_uuid — Customer UUID
  - field
  - name — Name
  - name_exact — Name (exact)
  - o — Which field to use when ordering the results.
  - scope — Filter by scope URL.
  - scope_uuid — Scope UUID
  - shared
  - state — State
  - type — Type

### service_settings_count
HEAD /api/service-settings/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (10):
  - customer — Customer UUID
  - customer_uuid — Customer UUID
  - name — Name
  - name_exact — Name (exact)
  - o — Which field to use when ordering the results.
  - scope — Filter by scope URL.
  - scope_uuid — Scope UUID
  - shared
  - state — State
  - type — Type

### service_settings_retrieve
GET /api/service-settings/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

============================================================
## slurm-allocation-user-usage  (module: waldur_api_client.api.slurm_allocation_user_usage)
============================================================

### slurm_allocation_user_usage_list
GET /api/slurm-allocation-user-usage/
Query parameters (6):
  - allocation
  - allocation_uuid
  - month
  - user
  - user_uuid
  - year

### slurm_allocation_user_usage_count
HEAD /api/slurm-allocation-user-usage/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - allocation
  - allocation_uuid
  - month
  - user
  - user_uuid
  - year

### slurm_allocation_user_usage_retrieve
GET /api/slurm-allocation-user-usage/{id}/
Path parameters:
  - id — A unique integer value identifying this allocation user usage.

============================================================
## slurm-allocations  (module: waldur_api_client.api.slurm_allocations)
============================================================

### slurm_allocations_list
GET /api/slurm-allocations/
Query parameters (19):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - is_active
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### slurm_allocations_count
HEAD /api/slurm-allocations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (18):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - is_active
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### slurm_allocations_create
POST /api/slurm-allocations/
Request body: yes

### slurm_allocations_retrieve
GET /api/slurm-allocations/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### slurm_allocations_update
PUT /api/slurm-allocations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### slurm_allocations_partial_update
PATCH /api/slurm-allocations/{uuid}/
Path parameters:
  - uuid
Request body: yes

### slurm_allocations_destroy
DELETE /api/slurm-allocations/{uuid}/
Path parameters:
  - uuid

### slurm_allocations_pull
POST /api/slurm-allocations/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### slurm_allocations_set_erred
POST /api/slurm-allocations/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### slurm_allocations_set_limits
POST /api/slurm-allocations/{uuid}/set_limits/
Path parameters:
  - uuid
Request body: yes

### slurm_allocations_set_ok
POST /api/slurm-allocations/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### slurm_allocations_unlink
POST /api/slurm-allocations/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## slurm-associations  (module: waldur_api_client.api.slurm_associations)
============================================================

### slurm_associations_list
GET /api/slurm-associations/
Query parameters (2):
  - allocation
  - allocation_uuid

### slurm_associations_count
HEAD /api/slurm-associations/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - allocation
  - allocation_uuid

### slurm_associations_retrieve
GET /api/slurm-associations/{uuid}/
Path parameters:
  - uuid

============================================================
## slurm-jobs  (module: waldur_api_client.api.slurm_jobs)
============================================================

### slurm_jobs_list
GET /api/slurm-jobs/
Query parameters (1):
  - field

### slurm_jobs_count
HEAD /api/slurm-jobs/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### slurm_jobs_create
POST /api/slurm-jobs/
Request body: yes

### slurm_jobs_retrieve
GET /api/slurm-jobs/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### slurm_jobs_update
PUT /api/slurm-jobs/{uuid}/
Path parameters:
  - uuid
Request body: yes

### slurm_jobs_partial_update
PATCH /api/slurm-jobs/{uuid}/
Path parameters:
  - uuid
Request body: yes

### slurm_jobs_destroy
DELETE /api/slurm-jobs/{uuid}/
Path parameters:
  - uuid

### slurm_jobs_pull
POST /api/slurm-jobs/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### slurm_jobs_set_erred
POST /api/slurm-jobs/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### slurm_jobs_set_ok
POST /api/slurm-jobs/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### slurm_jobs_unlink
POST /api/slurm-jobs/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## stats  (module: waldur_api_client.api.stats)
============================================================

### stats_celery_retrieve
GET /api/stats/celery/
Summary: Get Celery worker statistics
Description: Provides a comprehensive snapshot of all Celery workers' status.

This endpoint returns detailed information about:
- **active**: Tasks currently being executed by workers
- **scheduled**: Tasks scheduled for future execution (with ETA)
- **reserved**: Tasks received by workers but not yet starte...

### stats_database_retrieve
GET /api/stats/database/
Summary: Get comprehensive database statistics
Description: Retrieves comprehensive statistics about the PostgreSQL database including:
- **Table statistics**: Top 10 largest tables by size
- **Connection statistics**: Active, idle, and waiting connections with utilization
- **Database size**: Total size, data size, and index size
- **Cache performance**:...

### stats_query
POST /api/stats/query/
Summary: Execute read-only SQL query
Description: Execute a given SQL query against a read-only database replica. This is a powerful tool for diagnostics and reporting, but should be used with caution. Requires staff user permissions.
Request body: yes

### stats_table_growth_retrieve
GET /api/stats/table-growth/
Summary: Get table growth statistics
Description: Retrieves historical table growth statistics for detecting abnormal patterns.

This endpoint returns:
- **date**: Current date of the statistics
- **weekly_threshold_percent**: Configured alert threshold for weekly growth
- **monthly_threshold_percent**: Configured alert threshold for monthly gro...

### stats_table_growth
POST /api/stats/table-growth/
Summary: Trigger table size sampling
Description: Triggers the sample_table_sizes Celery task to collect current table size data. Requires staff permissions.

============================================================
## support  (module: waldur_api_client.api.support)
============================================================

### support_settings_atlassian_list
GET /api/support/settings/atlassian/

### support_settings_atlassian_create
POST /api/support/settings/atlassian/

### support_settings_atlassian_current_settings_retrieve
GET /api/support/settings/atlassian/current_settings/
Summary: Get current Atlassian settings (masked secrets)
Description: Get current Atlassian settings (masked secrets).

### support_settings_atlassian_discover_custom_fields
POST /api/support/settings/atlassian/discover_custom_fields/
Summary: Discover available custom fields
Description: Discover available custom fields.
Request body: yes

### support_settings_atlassian_discover_priorities
POST /api/support/settings/atlassian/discover_priorities/
Summary: Discover available priorities
Description: Discover available priorities.
Request body: yes

### support_settings_atlassian_discover_projects
POST /api/support/settings/atlassian/discover_projects/
Summary: Discover available Service Desk projects
Description: Discover available Service Desk projects.
Request body: yes

### support_settings_atlassian_discover_request_types
POST /api/support/settings/atlassian/discover_request_types/
Summary: Discover request types for a selected project
Description: Discover request types for a selected project.
Request body: yes

### support_settings_atlassian_preview_settings
POST /api/support/settings/atlassian/preview_settings/
Summary: Generate preview of settings to be saved
Description: Generate preview of settings to be saved.
Request body: yes

### support_settings_atlassian_save_settings
POST /api/support/settings/atlassian/save_settings/
Summary: Save selected settings to constance
Description: Save selected settings to constance.
Request body: yes

### support_settings_atlassian_validate_credentials
POST /api/support/settings/atlassian/validate_credentials/
Summary: Validate Atlassian credentials without saving them
Description: Validate Atlassian credentials without saving them.
Request body: yes

### support_settings_atlassian_retrieve
GET /api/support/settings/atlassian/{id}/
Path parameters:
  - id — A unique integer value identifying this issue.

### support_settings_atlassian_update
PUT /api/support/settings/atlassian/{id}/
Path parameters:
  - id — A unique integer value identifying this issue.

### support_settings_atlassian_partial_update
PATCH /api/support/settings/atlassian/{id}/
Path parameters:
  - id — A unique integer value identifying this issue.

### support_settings_atlassian_destroy
DELETE /api/support/settings/atlassian/{id}/
Path parameters:
  - id — A unique integer value identifying this issue.

============================================================
## support-attachments  (module: waldur_api_client.api.support_attachments)
============================================================

### support_attachments_list
GET /api/support-attachments/
Query parameters (3):
  - field
  - issue
  - issue_uuid

### support_attachments_count
HEAD /api/support-attachments/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - issue
  - issue_uuid

### support_attachments_create
POST /api/support-attachments/
Request body: yes

### support_attachments_retrieve
GET /api/support-attachments/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### support_attachments_destroy
DELETE /api/support-attachments/{uuid}/
Path parameters:
  - uuid

============================================================
## support-comments  (module: waldur_api_client.api.support_comments)
============================================================

### support_comments_list
GET /api/support-comments/
Query parameters (9):
  - author_name
  - author_user
  - description
  - is_public
  - issue
  - issue_uuid
  - o — Ordering
  - remote_id_is_set — Remote ID is set.
  - resource — Filter by resource URL.

### support_comments_count
HEAD /api/support-comments/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - author_name
  - author_user
  - description
  - is_public
  - issue
  - issue_uuid
  - o — Ordering
  - remote_id_is_set — Remote ID is set.
  - resource — Filter by resource URL.

### support_comments_retrieve
GET /api/support-comments/{uuid}/
Path parameters:
  - uuid

### support_comments_update
PUT /api/support-comments/{uuid}/
Path parameters:
  - uuid
Request body: yes

### support_comments_partial_update
PATCH /api/support-comments/{uuid}/
Path parameters:
  - uuid
Request body: yes

### support_comments_destroy
DELETE /api/support-comments/{uuid}/
Path parameters:
  - uuid

============================================================
## support-feedback-average-report  (module: waldur_api_client.api.support_feedback_average_report)
============================================================

### support_feedback_average_report_retrieve
GET /api/support-feedback-average-report/

============================================================
## support-feedback-report  (module: waldur_api_client.api.support_feedback_report)
============================================================

### support_feedback_report_retrieve
GET /api/support-feedback-report/

============================================================
## support-feedbacks  (module: waldur_api_client.api.support_feedbacks)
============================================================

### support_feedbacks_list
GET /api/support-feedbacks/
Query parameters (9):
  - created_after
  - created_before
  - evaluation
  - issue
  - issue_key
  - issue_uuid
  - user
  - user_full_name — User full name contains
  - user_uuid

### support_feedbacks_count
HEAD /api/support-feedbacks/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - created_after
  - created_before
  - evaluation
  - issue
  - issue_key
  - issue_uuid
  - user
  - user_full_name — User full name contains
  - user_uuid

### support_feedbacks_create
POST /api/support-feedbacks/
Request body: yes

### support_feedbacks_retrieve
GET /api/support-feedbacks/{uuid}/
Path parameters:
  - uuid

============================================================
## support-issue-statuses  (module: waldur_api_client.api.support_issue_statuses)
============================================================

### support_issue_statuses_list
GET /api/support-issue-statuses/

### support_issue_statuses_count
HEAD /api/support-issue-statuses/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### support_issue_statuses_create
POST /api/support-issue-statuses/
Request body: yes

### support_issue_statuses_retrieve
GET /api/support-issue-statuses/{uuid}/
Path parameters:
  - uuid

### support_issue_statuses_update
PUT /api/support-issue-statuses/{uuid}/
Path parameters:
  - uuid
Request body: yes

### support_issue_statuses_partial_update
PATCH /api/support-issue-statuses/{uuid}/
Path parameters:
  - uuid
Request body: yes

### support_issue_statuses_destroy
DELETE /api/support-issue-statuses/{uuid}/
Path parameters:
  - uuid

============================================================
## support-issues  (module: waldur_api_client.api.support_issues)
============================================================

### support_issues_list
GET /api/support-issues/
Query parameters (22):
  - assignee
  - assignee_name
  - caller
  - caller_full_name — Caller full name contains
  - customer
  - customer_uuid
  - key
  - o — Ordering
  - project
  - project_uuid
  - query — Summary or key contains
  - remote_id
  - reporter
  - reporter_name
  - resolution_year_month
  - resource — Filter by resource URL.
  - resource_external_ip — Resource external IP
  - resource_internal_ip — Resource internal IP
  - resource_uuid — Resource UUID
  - status
  - summary
  - type

### support_issues_count
HEAD /api/support-issues/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (22):
  - assignee
  - assignee_name
  - caller
  - caller_full_name — Caller full name contains
  - customer
  - customer_uuid
  - key
  - o — Ordering
  - project
  - project_uuid
  - query — Summary or key contains
  - remote_id
  - reporter
  - reporter_name
  - resolution_year_month
  - resource — Filter by resource URL.
  - resource_external_ip — Resource external IP
  - resource_internal_ip — Resource internal IP
  - resource_uuid — Resource UUID
  - status
  - summary
  - type

### support_issues_create
POST /api/support-issues/
Request body: yes

### support_issues_retrieve
GET /api/support-issues/{uuid}/
Path parameters:
  - uuid

### support_issues_update
PUT /api/support-issues/{uuid}/
Path parameters:
  - uuid
Request body: yes

### support_issues_partial_update
PATCH /api/support-issues/{uuid}/
Path parameters:
  - uuid
Request body: yes

### support_issues_destroy
DELETE /api/support-issues/{uuid}/
Path parameters:
  - uuid

### support_issues_comment
POST /api/support-issues/{uuid}/comment/
Path parameters:
  - uuid
Request body: yes

### support_issues_sync
POST /api/support-issues/{uuid}/sync/
Path parameters:
  - uuid

============================================================
## support-jira-webhook  (module: waldur_api_client.api.support_jira_webhook)
============================================================

### support_jira_webhook
POST /api/support-jira-webhook/
Request body: yes

============================================================
## support-priorities  (module: waldur_api_client.api.support_priorities)
============================================================

### support_priorities_list
GET /api/support-priorities/
Query parameters (2):
  - name — Name
  - name_exact — Name (exact)

### support_priorities_count
HEAD /api/support-priorities/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - name — Name
  - name_exact — Name (exact)

### support_priorities_retrieve
GET /api/support-priorities/{uuid}/
Path parameters:
  - uuid

============================================================
## support-request-types  (module: waldur_api_client.api.support_request_types)
============================================================

### support_request_types_list
GET /api/support-request-types/

### support_request_types_count
HEAD /api/support-request-types/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### support_request_types_retrieve
GET /api/support-request-types/{uuid}/
Path parameters:
  - uuid

============================================================
## support-request-types-admin  (module: waldur_api_client.api.support_request_types_admin)
============================================================

### support_request_types_admin_list
GET /api/support-request-types-admin/
Query parameters (2):
  - is_active
  - name

### support_request_types_admin_count
HEAD /api/support-request-types-admin/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - is_active
  - name

### support_request_types_admin_create
POST /api/support-request-types-admin/
Request body: yes

### support_request_types_admin_reorder
POST /api/support-request-types-admin/reorder/
Summary: Bulk update order for multiple request types
Description: Bulk update order for multiple request types.
Request body: yes

### support_request_types_admin_retrieve
GET /api/support-request-types-admin/{uuid}/
Path parameters:
  - uuid

### support_request_types_admin_update
PUT /api/support-request-types-admin/{uuid}/
Path parameters:
  - uuid
Request body: yes

### support_request_types_admin_partial_update
PATCH /api/support-request-types-admin/{uuid}/
Path parameters:
  - uuid
Request body: yes

### support_request_types_admin_destroy
DELETE /api/support-request-types-admin/{uuid}/
Path parameters:
  - uuid

### support_request_types_admin_activate
POST /api/support-request-types-admin/{uuid}/activate/
Summary: Activate a request type so it appears in issue creation
Description: Activate a request type so it appears in issue creation.
Path parameters:
  - uuid

### support_request_types_admin_deactivate
POST /api/support-request-types-admin/{uuid}/deactivate/
Summary: Deactivate a request type so it no longer appears in issue creation
Description: Deactivate a request type so it no longer appears in issue creation.
Path parameters:
  - uuid

============================================================
## support-smax-webhook  (module: waldur_api_client.api.support_smax_webhook)
============================================================

### support_smax_webhook
POST /api/support-smax-webhook/
Request body: yes

============================================================
## support-statistics  (module: waldur_api_client.api.support_statistics)
============================================================

### support_statistics_retrieve
GET /api/support-statistics/

============================================================
## support-templates  (module: waldur_api_client.api.support_templates)
============================================================

### support_templates_list
GET /api/support-templates/

### support_templates_count
HEAD /api/support-templates/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### support_templates_create
POST /api/support-templates/
Request body: yes

### support_templates_retrieve
GET /api/support-templates/{uuid}/
Path parameters:
  - uuid

### support_templates_update
PUT /api/support-templates/{uuid}/
Path parameters:
  - uuid
Request body: yes

### support_templates_partial_update
PATCH /api/support-templates/{uuid}/
Path parameters:
  - uuid
Request body: yes

### support_templates_destroy
DELETE /api/support-templates/{uuid}/
Path parameters:
  - uuid

### support_templates_create_attachments
POST /api/support-templates/{uuid}/create_attachments/
Summary: This view attaches documents to template
Description: This view attaches documents to template.
Path parameters:
  - uuid
Request body: yes

### support_templates_delete_attachments
POST /api/support-templates/{uuid}/delete_attachments/
Path parameters:
  - uuid
Request body: yes

============================================================
## support-users  (module: waldur_api_client.api.support_users)
============================================================

### support_users_list
GET /api/support-users/
Query parameters (3):
  - backend_id
  - name
  - user

### support_users_count
HEAD /api/support-users/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (3):
  - backend_id
  - name
  - user

### support_users_retrieve
GET /api/support-users/{uuid}/
Path parameters:
  - uuid

============================================================
## support-zammad-webhook  (module: waldur_api_client.api.support_zammad_webhook)
============================================================

### support_zammad_webhook
POST /api/support-zammad-webhook/

============================================================
## sync-issues  (module: waldur_api_client.api.sync_issues)
============================================================

### sync_issues_retrieve
GET /api/sync-issues/
Summary: This view triggers synchronization of issues from backend
Description: This view triggers synchronization of issues from backend.

### sync_issues
POST /api/sync-issues/
Summary: This view triggers synchronization of issues from backend
Description: This view triggers synchronization of issues from backend.

============================================================
## system-logs  (module: waldur_api_client.api.system_logs)
============================================================

### system_logs_list
GET /api/system-logs/
Query parameters (9):
  - created_from
  - created_to
  - instance
  - level
  - level_gte — Min level: 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL
  - logger_name
  - message
  - o — Ordering
  - source

### system_logs_count
HEAD /api/system-logs/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - created_from
  - created_to
  - instance
  - level
  - level_gte — Min level: 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL
  - logger_name
  - message
  - o — Ordering
  - source

### system_logs_instances_list
GET /api/system-logs/instances/
Summary: List system log instances
Description: List all known instances (pods/containers) with their last activity.
Query parameters (9):
  - created_from
  - created_to
  - instance
  - level
  - level_gte — Min level: 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL
  - logger_name
  - message
  - o — Ordering
  - source

### system_logs_instances_count
HEAD /api/system-logs/instances/
Summary: List system log instances
Description: Get number of items in the collection matching the request parameters.
Query parameters (9):
  - created_from
  - created_to
  - instance
  - level
  - level_gte — Min level: 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL
  - logger_name
  - message
  - o — Ordering
  - source

### system_logs_stats_retrieve
GET /api/system-logs/stats/
Summary: Get system log statistics
Description: Return log count statistics per source and instance, plus total table size.

### system_logs_stats_count
HEAD /api/system-logs/stats/
Summary: Get system log statistics
Description: Get number of items in the collection matching the request parameters.

### system_logs_retrieve
GET /api/system-logs/{id}/
Path parameters:
  - id — A unique integer value identifying this system log.

============================================================
## user-action-executions  (module: waldur_api_client.api.user_action_executions)
============================================================

### user_action_executions_list
GET /api/user-action-executions/
Query parameters (1):
  - o — Which field to use when ordering the results.

### user_action_executions_count
HEAD /api/user-action-executions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (1):
  - o — Which field to use when ordering the results.

### user_action_executions_retrieve
GET /api/user-action-executions/{id}/
Path parameters:
  - id — A unique integer value identifying this user action execution.

============================================================
## user-action-providers  (module: waldur_api_client.api.user_action_providers)
============================================================

### user_action_providers_list
GET /api/user-action-providers/

### user_action_providers_count
HEAD /api/user-action-providers/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### user_action_providers_retrieve
GET /api/user-action-providers/{id}/
Path parameters:
  - id — A unique integer value identifying this user action provider.

============================================================
## user-actions  (module: waldur_api_client.api.user_actions)
============================================================

### user_actions_list
GET /api/user-actions/
Query parameters (10):
  - action_type
  - created_after
  - created_before
  - due_within_days
  - include_silenced
  - is_silenced
  - o — Which field to use when ordering the results.
  - overdue
  - urgency
  - user_uuid — Filter by user UUID (staff only).

### user_actions_count
HEAD /api/user-actions/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (10):
  - action_type
  - created_after
  - created_before
  - due_within_days
  - include_silenced
  - is_silenced
  - o — Which field to use when ordering the results.
  - overdue
  - urgency
  - user_uuid — Filter by user UUID (staff only).

### user_actions_bulk_silence
POST /api/user-actions/bulk_silence/
Summary: Bulk silence actions by filters
Request body: yes

### user_actions_summary_retrieve
GET /api/user-actions/summary/
Summary: Get action summary counts

### user_actions_summary_count
HEAD /api/user-actions/summary/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.

### user_actions_update_actions
POST /api/user-actions/update_actions/
Summary: Trigger update of user actions
Request body: yes

### user_actions_retrieve
GET /api/user-actions/{uuid}/
Path parameters:
  - uuid

### user_actions_execute_action
POST /api/user-actions/{uuid}/execute_action/
Summary: Execute a corrective action
Path parameters:
  - uuid
Request body: yes

### user_actions_silence
POST /api/user-actions/{uuid}/silence/
Summary: Silence an action temporarily or permanently
Path parameters:
  - uuid
Request body: yes

### user_actions_unsilence
POST /api/user-actions/{uuid}/unsilence/
Summary: Remove silence from an action
Path parameters:
  - uuid

============================================================
## user-agreements  (module: waldur_api_client.api.user_agreements)
============================================================

### user_agreements_list
GET /api/user-agreements/
Summary: List user agreements
Description: Retrieve a list of user agreements (Terms of Service and Privacy Policy). Supports filtering by agreement type and language with fallback behavior.
Query parameters (2):
  - agreement_type
  - language — ISO 639-1 language code (e.g., 'en', 'de', 'et'). Returns requested language or falls back to default version if unavailable.

### user_agreements_count
HEAD /api/user-agreements/
Summary: List user agreements
Description: Get number of items in the collection matching the request parameters.
Query parameters (2):
  - agreement_type
  - language — ISO 639-1 language code (e.g., 'en', 'de', 'et'). Returns requested language or falls back to default version if unavailable.

### user_agreements_create
POST /api/user-agreements/
Request body: yes

### user_agreements_retrieve
GET /api/user-agreements/{uuid}/
Summary: Retrieve user agreement
Description: Fetch the details of a specific user agreement by its UUID.
Path parameters:
  - uuid

### user_agreements_update
PUT /api/user-agreements/{uuid}/
Path parameters:
  - uuid
Request body: yes

### user_agreements_partial_update
PATCH /api/user-agreements/{uuid}/
Path parameters:
  - uuid
Request body: yes

### user_agreements_destroy
DELETE /api/user-agreements/{uuid}/
Path parameters:
  - uuid

============================================================
## user-group-invitations  (module: waldur_api_client.api.user_group_invitations)
============================================================

### user_group_invitations_list
GET /api/user-group-invitations/
Summary: List group invitations
Description: Retrieve a list of group invitations. Unauthenticated users can only see public invitations.
Query parameters (8):
  - customer_uuid
  - is_active
  - is_public
  - o — Ordering
  - role_name
  - role_uuid
  - scope — Filter by scope URL.
  - scope_type

### user_group_invitations_count
HEAD /api/user-group-invitations/
Summary: List group invitations
Description: Get number of items in the collection matching the request parameters.
Query parameters (8):
  - customer_uuid
  - is_active
  - is_public
  - o — Ordering
  - role_name
  - role_uuid
  - scope — Filter by scope URL.
  - scope_type

### user_group_invitations_create
POST /api/user-group-invitations/
Summary: Create group invitation
Description: Create a new group invitation, which acts as a template for users to request permissions.
Request body: yes

### user_group_invitations_retrieve
GET /api/user-group-invitations/{uuid}/
Summary: Retrieve group invitation
Description: Retrieve details of a specific group invitation. Unauthenticated users can only see public invitations.
Path parameters:
  - uuid

### user_group_invitations_update
PUT /api/user-group-invitations/{uuid}/
Summary: Update a group invitation
Description: Update an active group invitation. Only active invitations can be edited.
Path parameters:
  - uuid
Request body: yes

### user_group_invitations_partial_update
PATCH /api/user-group-invitations/{uuid}/
Summary: Partially update a group invitation
Description: Partially update an active group invitation. Only active invitations can be edited.
Path parameters:
  - uuid
Request body: yes

### user_group_invitations_destroy
DELETE /api/user-group-invitations/{uuid}/
Summary: Delete a group invitation
Description: Deletes an inactive group invitation. Only invitations that have been canceled (is_active=False) can be deleted.
Path parameters:
  - uuid

### user_group_invitations_cancel
POST /api/user-group-invitations/{uuid}/cancel/
Summary: Cancel a group invitation
Description: Cancels an active group invitation, preventing new permission requests from being created.
Path parameters:
  - uuid

### user_group_invitations_projects_list
GET /api/user-group-invitations/{uuid}/projects/
Summary: List projects for a customer-scoped group invitation
Description: For a group invitation scoped to a customer, this endpoint lists all projects within that customer.
Path parameters:
  - uuid

### user_group_invitations_submit_request
POST /api/user-group-invitations/{uuid}/submit_request/
Summary: Submit a permission request
Description: Creates a permission request based on a group invitation for the currently authenticated user. If the invitation has auto_approve enabled and the user matches the required patterns, the request is automatically approved.
Path parameters:
  - uuid
Request body: yes

============================================================
## user-invitations  (module: waldur_api_client.api.user_invitations)
============================================================

### user_invitations_list
GET /api/user-invitations/
Summary: List user invitations
Description: Retrieve a list of user invitations visible to the current user.
Query parameters (12):
  - civil_number
  - customer_uuid
  - email
  - email_exact
  - o — Ordering
  - role_name
  - role_uuid
  - scope — Filter by scope URL.
  - scope_description
  - scope_name
  - scope_type
  - state

### user_invitations_count
HEAD /api/user-invitations/
Summary: List user invitations
Description: Get number of items in the collection matching the request parameters.
Query parameters (12):
  - civil_number
  - customer_uuid
  - email
  - email_exact
  - o — Ordering
  - role_name
  - role_uuid
  - scope — Filter by scope URL.
  - scope_description
  - scope_name
  - scope_type
  - state

### user_invitations_create
POST /api/user-invitations/
Summary: Create user invitation
Description: Create a new user invitation to grant a role in a specific scope (e.g., organization or project).
Request body: yes

### user_invitations_approve
POST /api/user-invitations/approve/
Summary: Approve a requested invitation
Description: For user's convenience invitation approval is performed without authentication.
        User UUID and invitation UUID is encoded into cryptographically signed token.
Request body: yes

### user_invitations_check_duplicates
POST /api/user-invitations/check-duplicates/
Summary: Check for duplicate invitations
Description: Returns pending invitations that already exist for the same email and role within the given scope.
Request body: yes

### user_invitations_reject
POST /api/user-invitations/reject/
Summary: Reject a requested invitation
Description: For user's convenience invitation reject action is performed without authentication.
        User UUID and invitation UUID is encoded into cryptographically signed token.
Request body: yes

### user_invitations_retrieve
GET /api/user-invitations/{uuid}/
Summary: Retrieve user invitation
Description: Retrieve details of a specific user invitation.
Path parameters:
  - uuid

### user_invitations_update
PUT /api/user-invitations/{uuid}/
Summary: Update user invitation
Description: Update an existing user invitation. Only pending invitations can be edited. Allows changing email and role within the same scope.
Path parameters:
  - uuid
Request body: yes

### user_invitations_partial_update
PATCH /api/user-invitations/{uuid}/
Summary: Partially update user invitation
Description: Partially update an existing user invitation. Only pending invitations can be edited. Allows changing email and role within the same scope.
Path parameters:
  - uuid
Request body: yes

### user_invitations_destroy
DELETE /api/user-invitations/{uuid}/
Summary: Delete user invitation
Description: Delete a user invitation. Only users with invitation management permissions can delete invitations.
Path parameters:
  - uuid

### user_invitations_accept
POST /api/user-invitations/{uuid}/accept/
Summary: Accept an invitation
Description: Accepts an invitation for the currently authenticated user. This grants the user the specified role in the invitation's scope.
Path parameters:
  - uuid

### user_invitations_cancel
POST /api/user-invitations/{uuid}/cancel/
Summary: Cancel an invitation
Description: Cancels a pending or planned (pending_project) invitation.
Path parameters:
  - uuid

### user_invitations_check
POST /api/user-invitations/{uuid}/check/
Summary: Check invitation validity
Description: Checks if an invitation is pending and returns its email and whether a civil number is required for acceptance. This endpoint is public and does not require authentication.
Path parameters:
  - uuid

### user_invitations_delete
POST /api/user-invitations/{uuid}/delete/
Summary: Delete an invitation (staff only)
Description: Deletes an invitation. This action is restricted to staff users.
Path parameters:
  - uuid

### user_invitations_details_retrieve
GET /api/user-invitations/{uuid}/details/
Summary: Get public invitation details
Description: Retrieves public-facing details of an invitation. This is used to show information to a user before they accept it.
Path parameters:
  - uuid

### user_invitations_send
POST /api/user-invitations/{uuid}/send/
Summary: Resend an invitation
Description: Resends an email for a pending, expired, or canceled invitation. If the invitation was expired or canceled, its state is reset to 'pending' and its creation time is updated.
Path parameters:
  - uuid

============================================================
## user-permission-requests  (module: waldur_api_client.api.user_permission_requests)
============================================================

### user_permission_requests_list
GET /api/user-permission-requests/
Summary: List permission requests
Description: Retrieve a list of permission requests visible to the user.
Query parameters (6):
  - created_by
  - customer_uuid
  - invitation
  - o — Ordering
  - scope — Filter by scope URL.
  - state

### user_permission_requests_count
HEAD /api/user-permission-requests/
Summary: List permission requests
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - created_by
  - customer_uuid
  - invitation
  - o — Ordering
  - scope — Filter by scope URL.
  - state

### user_permission_requests_retrieve
GET /api/user-permission-requests/{uuid}/
Summary: Retrieve permission request
Description: Retrieve details of a specific permission request.
Path parameters:
  - uuid

### user_permission_requests_destroy
DELETE /api/user-permission-requests/{uuid}/
Summary: Delete a permission request (staff only)
Description: Deletes a permission request. This action is restricted to staff users.
Path parameters:
  - uuid

### user_permission_requests_approve
POST /api/user-permission-requests/{uuid}/approve/
Summary: Approve a permission request
Description: Approves a pending permission request, granting the requesting user the permissions defined in the associated group invitation.
Path parameters:
  - uuid
Request body: yes

### user_permission_requests_cancel_request
POST /api/user-permission-requests/{uuid}/cancel_request/
Summary: Cancel a permission request
Description: Cancels a pending or draft permission request. This can be done by the user who created the request or by a staff member.
Path parameters:
  - uuid

### user_permission_requests_reject
POST /api/user-permission-requests/{uuid}/reject/
Summary: Reject a permission request
Description: Rejects a pending permission request.
Path parameters:
  - uuid
Request body: yes

============================================================
## user-permissions  (module: waldur_api_client.api.user_permissions)
============================================================

### user_permissions_list
GET /api/user-permissions/
Summary: List user permissions
Description: Get a list of all permissions for the current user. Staff and support users can view all user permissions. The list can be filtered by user, scope, role, etc. By default only active grants are returned; staff and support can pass show_inactive=true to include revoked grants (the full history).
Query parameters (19):
  - created — Created after
  - created_before — Created before
  - expiration_time
  - full_name — User full name contains
  - is_active
  - modified — Modified after
  - modified_before — Modified before
  - native_name
  - o — Ordering
  - role_name — Role name contains
  - role_uuid — Role UUID
  - scope_name — Scope name
  - scope_type — Scope type
  - scope_uuid — Scope UUID
  - show_inactive — Staff/support only. Include revoked (inactive) role grants in addition to active ones. Ignored for other users, who only ever see their own active roles.
  - user
  - user_slug — User slug contains
  - user_url
  - username

### user_permissions_count
HEAD /api/user-permissions/
Summary: List user permissions
Description: Get number of items in the collection matching the request parameters.
Query parameters (19):
  - created — Created after
  - created_before — Created before
  - expiration_time
  - full_name — User full name contains
  - is_active
  - modified — Modified after
  - modified_before — Modified before
  - native_name
  - o — Ordering
  - role_name — Role name contains
  - role_uuid — Role UUID
  - scope_name — Scope name
  - scope_type — Scope type
  - scope_uuid — Scope UUID
  - show_inactive — Staff/support only. Include revoked (inactive) role grants in addition to active ones. Ignored for other users, who only ever see their own active roles.
  - user
  - user_slug — User slug contains
  - user_url
  - username

### user_permissions_retrieve
GET /api/user-permissions/{uuid}/
Summary: Get permission details
Description: Retrieve the details of a specific user permission grant by its UUID.
Path parameters:
  - uuid

### user_permissions_restore
POST /api/user-permissions/{uuid}/restore/
Summary: Restore a revoked user role
Description: Restores a previously revoked user role grant, reinstating the associated permissions immediately. Restoring a role whose scope (e.g. a project) has been soft-deleted is not allowed.
Path parameters:
  - uuid
Request body: yes

### user_permissions_revoke
POST /api/user-permissions/{uuid}/revoke/
Summary: Revoke a user role
Description: Revokes a specific user role grant, deactivating the associated permissions immediately.
Path parameters:
  - uuid
Request body: yes

============================================================
## users  (module: waldur_api_client.api.users)
============================================================

### users_list
GET /api/users/
Query parameters (25):
  - agreement_date — Agreement date after
  - civil_number
  - customer_uuid — Customer UUID
  - date_joined — Date joined after
  - description
  - email — Email
  - field
  - full_name — Full name
  - is_active — Is active
  - is_staff — Is staff
  - is_support — Is support
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering
  - organization — Organization
  - organization_roles — Organization roles
  - phone_number
  - project_roles — Project roles
  - project_uuid — Project UUID
  - query — Filter by first name, last name, civil number, username or email
  - registration_method
  - user_keyword — User keyword
  - username — Username (exact)
  - username_list — Comma-separated usernames

### users_count
HEAD /api/users/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (24):
  - agreement_date — Agreement date after
  - civil_number
  - customer_uuid — Customer UUID
  - date_joined — Date joined after
  - description
  - email — Email
  - full_name — Full name
  - is_active — Is active
  - is_staff — Is staff
  - is_support — Is support
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering
  - organization — Organization
  - organization_roles — Organization roles
  - phone_number
  - project_roles — Project roles
  - project_uuid — Project UUID
  - query — Filter by first name, last name, civil number, username or email
  - registration_method
  - user_keyword — User keyword
  - username — Username (exact)
  - username_list — Comma-separated usernames

### users_create
POST /api/users/
Request body: yes

### users_confirm_email
POST /api/users/confirm_email/
Summary: Confirm email change
Description: Confirm email update using code
Request body: yes

### users_me_retrieve
GET /api/users/me/
Summary: Get current user details
Description: Get current user details, including authentication token and profile completeness status.
Query parameters (1):
  - field

### users_me_count
HEAD /api/users/me/
Summary: Get current user details
Description: Get number of items in the collection matching the request parameters.

### users_profile_completeness_retrieve
GET /api/users/profile_completeness/
Summary: Check profile completeness
Description: Check if user profile is complete with all mandatory attributes.

### users_profile_completeness_count
HEAD /api/users/profile_completeness/
Summary: Check profile completeness
Description: Get number of items in the collection matching the request parameters.

### users_scim_sync_all
POST /api/users/scim_sync_all/
Summary: Trigger SCIM synchronization for all users
Description: Staff-only action to queue SCIM synchronization for all users.

### users_user_active_status_count_list
GET /api/users/user_active_status_count/
Summary: Get user counts by active status
Description: Returns aggregated counts of users by active/inactive status. Staff or support only.
Query parameters (24):
  - agreement_date — Agreement date after
  - civil_number
  - customer_uuid — Customer UUID
  - date_joined — Date joined after
  - description
  - email — Email
  - full_name — Full name
  - is_active — Is active
  - is_staff — Is staff
  - is_support — Is support
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering
  - organization — Organization
  - organization_roles — Organization roles
  - phone_number
  - project_roles — Project roles
  - project_uuid — Project UUID
  - query — Filter by first name, last name, civil number, username or email
  - registration_method
  - user_keyword — User keyword
  - username — Username (exact)
  - username_list — Comma-separated usernames

### users_user_active_status_count_count
HEAD /api/users/user_active_status_count/
Summary: Get user counts by active status
Description: Get number of items in the collection matching the request parameters.
Query parameters (24):
  - agreement_date — Agreement date after
  - civil_number
  - customer_uuid — Customer UUID
  - date_joined — Date joined after
  - description
  - email — Email
  - full_name — Full name
  - is_active — Is active
  - is_staff — Is staff
  - is_support — Is support
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering
  - organization — Organization
  - organization_roles — Organization roles
  - phone_number
  - project_roles — Project roles
  - project_uuid — Project UUID
  - query — Filter by first name, last name, civil number, username or email
  - registration_method
  - user_keyword — User keyword
  - username — Username (exact)
  - username_list — Comma-separated usernames

### users_user_language_count_list
GET /api/users/user_language_count/
Summary: Get user counts by preferred language
Description: Returns aggregated counts of users by preferred language. Staff or support only.
Query parameters (24):
  - agreement_date — Agreement date after
  - civil_number
  - customer_uuid — Customer UUID
  - date_joined — Date joined after
  - description
  - email — Email
  - full_name — Full name
  - is_active — Is active
  - is_staff — Is staff
  - is_support — Is support
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering
  - organization — Organization
  - organization_roles — Organization roles
  - phone_number
  - project_roles — Project roles
  - project_uuid — Project UUID
  - query — Filter by first name, last name, civil number, username or email
  - registration_method
  - user_keyword — User keyword
  - username — Username (exact)
  - username_list — Comma-separated usernames

### users_user_language_count_count
HEAD /api/users/user_language_count/
Summary: Get user counts by preferred language
Description: Get number of items in the collection matching the request parameters.
Query parameters (24):
  - agreement_date — Agreement date after
  - civil_number
  - customer_uuid — Customer UUID
  - date_joined — Date joined after
  - description
  - email — Email
  - full_name — Full name
  - is_active — Is active
  - is_staff — Is staff
  - is_support — Is support
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering
  - organization — Organization
  - organization_roles — Organization roles
  - phone_number
  - project_roles — Project roles
  - project_uuid — Project UUID
  - query — Filter by first name, last name, civil number, username or email
  - registration_method
  - user_keyword — User keyword
  - username — Username (exact)
  - username_list — Comma-separated usernames

### users_user_registration_trend_list
GET /api/users/user_registration_trend/
Summary: Get user registration trends by month
Description: Returns user registration counts aggregated by month. Staff or support only.
Query parameters (24):
  - agreement_date — Agreement date after
  - civil_number
  - customer_uuid — Customer UUID
  - date_joined — Date joined after
  - description
  - email — Email
  - full_name — Full name
  - is_active — Is active
  - is_staff — Is staff
  - is_support — Is support
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering
  - organization — Organization
  - organization_roles — Organization roles
  - phone_number
  - project_roles — Project roles
  - project_uuid — Project UUID
  - query — Filter by first name, last name, civil number, username or email
  - registration_method
  - user_keyword — User keyword
  - username — Username (exact)
  - username_list — Comma-separated usernames

### users_user_registration_trend_count
HEAD /api/users/user_registration_trend/
Summary: Get user registration trends by month
Description: Get number of items in the collection matching the request parameters.
Query parameters (24):
  - agreement_date — Agreement date after
  - civil_number
  - customer_uuid — Customer UUID
  - date_joined — Date joined after
  - description
  - email — Email
  - full_name — Full name
  - is_active — Is active
  - is_staff — Is staff
  - is_support — Is support
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering
  - organization — Organization
  - organization_roles — Organization roles
  - phone_number
  - project_roles — Project roles
  - project_uuid — Project UUID
  - query — Filter by first name, last name, civil number, username or email
  - registration_method
  - user_keyword — User keyword
  - username — Username (exact)
  - username_list — Comma-separated usernames

### users_retrieve
GET /api/users/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### users_update
PUT /api/users/{uuid}/
Path parameters:
  - uuid
Request body: yes

### users_partial_update
PATCH /api/users/{uuid}/
Path parameters:
  - uuid
Request body: yes

### users_destroy
DELETE /api/users/{uuid}/
Path parameters:
  - uuid

### users_cancel_change_email
POST /api/users/{uuid}/cancel_change_email/
Summary: Cancel email change request
Description: Cancel email update request
Path parameters:
  - uuid

### users_change_email
POST /api/users/{uuid}/change_email/
Summary: Request email change
Description: Allows to change email for user.
Path parameters:
  - uuid
Request body: yes

### users_change_password
POST /api/users/{uuid}/change_password/
Summary: Change user password
Description: Allows staff user to change password for any user.
Path parameters:
  - uuid
Request body: yes

### users_data_access_retrieve
GET /api/users/{uuid}/data_access/
Summary: Get user data access visibility
Description: Shows who has access to the user's profile data. Includes administrative access (staff/support), organizational access (same customer/project), and service provider access (via consent). Regular users see counts for admin access; staff/support see individual records.
Path parameters:
  - uuid

### users_data_access_history_list
GET /api/users/{uuid}/data_access_history/
Summary: Get user data access history
Description: Shows historical log of who has accessed the user's profile data. Regular users see anonymized accessor categories. Staff/support see full details including accessor identity, IP, and context.
Path parameters:
  - uuid
Query parameters (27):
  - accessor_type — Filter by accessor type (staff, support, organization_member, self)
  - agreement_date — Agreement date after
  - civil_number
  - customer_uuid — Customer UUID
  - date_joined — Date joined after
  - description
  - email — Email
  - end_date — Filter logs until this date (inclusive)
  - full_name — Full name
  - is_active — Is active
  - is_staff — Is staff
  - is_support — Is support
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering
  - organization — Organization
  - organization_roles — Organization roles
  - phone_number
  - project_roles — Project roles
  - project_uuid — Project UUID
  - query — Filter by first name, last name, civil number, username or email
  - registration_method
  - start_date — Filter logs from this date (inclusive)
  - user_keyword — User keyword
  - username — Username (exact)
  - username_list — Comma-separated usernames

### users_history_list
GET /api/users/{uuid}/history/
Summary: Get version history
Description: Returns the version history for this object. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (26):
  - agreement_date — Agreement date after
  - civil_number
  - created_after — Filter versions created after this timestamp (ISO 8601)
  - created_before — Filter versions created before this timestamp (ISO 8601)
  - customer_uuid — Customer UUID
  - date_joined — Date joined after
  - description
  - email — Email
  - full_name — Full name
  - is_active — Is active
  - is_staff — Is staff
  - is_support — Is support
  - job_title — Job title
  - modified — Date modified after
  - native_name — Native name
  - o — Ordering
  - organization — Organization
  - organization_roles — Organization roles
  - phone_number
  - project_roles — Project roles
  - project_uuid — Project UUID
  - query — Filter by first name, last name, civil number, username or email
  - registration_method
  - user_keyword — User keyword
  - username — Username (exact)
  - username_list — Comma-separated usernames

### users_history_at_retrieve
GET /api/users/{uuid}/history/at/
Summary: Get object state at a specific timestamp
Description: Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
Path parameters:
  - uuid
Query parameters (1):
  - timestamp (required) — ISO 8601 timestamp to query the object state at

### users_identity_bridge_status_retrieve
GET /api/users/{uuid}/identity_bridge_status/
Summary: Get identity bridge status for a user
Description: Returns diagnostic information about a user's identity bridge state: active ISDs, per-attribute source tracking with staleness detection, and effective bridge-writable fields. Staff only.
Path parameters:
  - uuid

### users_pull_remote_user
POST /api/users/{uuid}/pull_remote_user/
Summary: Synchronize user details from eduTEAMS
Path parameters:
  - uuid

### users_pull_scim_attributes
POST /api/users/{uuid}/pull_scim_attributes/
Summary: Pull SCIM attributes from external IdP for this user
Description: Staff-only action that pulls the user's attributes from the configured external SCIM 2.0 directory (SCIM_PULL_API_URL). Pulled attributes are merged via the same source-aware policy as inbound SCIM and the Identity Bridge.
Path parameters:
  - uuid

### users_refresh_token
POST /api/users/{uuid}/refresh_token/
Summary: Refresh user auth token
Path parameters:
  - uuid

### users_remove_password
POST /api/users/{uuid}/remove_password/
Summary: Remove user password
Description: Allows staff user to remove password for any user, making it unusable.
Path parameters:
  - uuid

### users_send_notification
POST /api/users/{uuid}/send_notification/
Summary: Send action notification to a specific user
Description: Staff-only action to send a pending actions digest notification to a specific user.
Path parameters:
  - uuid

### users_token_retrieve
GET /api/users/{uuid}/token/
Summary: Get user auth token
Path parameters:
  - uuid

### users_update_actions
POST /api/users/{uuid}/update_actions/
Summary: Recalculate user actions for a specific user
Description: Staff-only action to trigger recalculation of user actions for a specific user.
Path parameters:
  - uuid
Request body: yes

============================================================
## version  (module: waldur_api_client.api.version)
============================================================

### version_retrieve
GET /api/version/
Summary: Get application version
Description: Retrieves the current installed version of the application and the latest available version from GitHub (if available). Requires staff or support user permissions.

============================================================
## vmware-clusters  (module: waldur_api_client.api.vmware_clusters)
============================================================

### vmware_clusters_list
GET /api/vmware-clusters/
Query parameters (5):
  - customer_uuid — Customer UUID
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### vmware_clusters_count
HEAD /api/vmware-clusters/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - customer_uuid — Customer UUID
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### vmware_clusters_retrieve
GET /api/vmware-clusters/{uuid}/
Path parameters:
  - uuid

============================================================
## vmware-datastores  (module: waldur_api_client.api.vmware_datastores)
============================================================

### vmware_datastores_list
GET /api/vmware-datastores/
Query parameters (5):
  - customer_uuid — Customer UUID
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### vmware_datastores_count
HEAD /api/vmware-datastores/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - customer_uuid — Customer UUID
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### vmware_datastores_retrieve
GET /api/vmware-datastores/{uuid}/
Path parameters:
  - uuid

============================================================
## vmware-disks  (module: waldur_api_client.api.vmware_disks)
============================================================

### vmware_disks_list
GET /api/vmware-disks/
Query parameters (20):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - vm
  - vm_uuid

### vmware_disks_count
HEAD /api/vmware-disks/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (19):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - vm
  - vm_uuid

### vmware_disks_retrieve
GET /api/vmware-disks/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### vmware_disks_destroy
DELETE /api/vmware-disks/{uuid}/
Path parameters:
  - uuid

### vmware_disks_extend
POST /api/vmware-disks/{uuid}/extend/
Summary: Increase disk capacity
Path parameters:
  - uuid
Request body: yes

### vmware_disks_pull
POST /api/vmware-disks/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### vmware_disks_set_erred
POST /api/vmware-disks/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### vmware_disks_set_ok
POST /api/vmware-disks/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### vmware_disks_unlink
POST /api/vmware-disks/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## vmware-folders  (module: waldur_api_client.api.vmware_folders)
============================================================

### vmware_folders_list
GET /api/vmware-folders/
Query parameters (5):
  - customer_uuid — Customer UUID
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### vmware_folders_count
HEAD /api/vmware-folders/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (5):
  - customer_uuid — Customer UUID
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### vmware_folders_retrieve
GET /api/vmware-folders/{uuid}/
Path parameters:
  - uuid

============================================================
## vmware-limits  (module: waldur_api_client.api.vmware_limits)
============================================================

### vmware_limits_retrieve
GET /api/vmware-limits/{uuid}/
Path parameters:
  - uuid

============================================================
## vmware-networks  (module: waldur_api_client.api.vmware_networks)
============================================================

### vmware_networks_list
GET /api/vmware-networks/
Query parameters (6):
  - customer_pair_uuid — Customer UUID
  - customer_uuid — Customer UUID
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### vmware_networks_count
HEAD /api/vmware-networks/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (6):
  - customer_pair_uuid — Customer UUID
  - customer_uuid — Customer UUID
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### vmware_networks_retrieve
GET /api/vmware-networks/{uuid}/
Path parameters:
  - uuid

============================================================
## vmware-ports  (module: waldur_api_client.api.vmware_ports)
============================================================

### vmware_ports_list
GET /api/vmware-ports/
Query parameters (22):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - network
  - network_uuid
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - vm
  - vm_uuid

### vmware_ports_count
HEAD /api/vmware-ports/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (21):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - network
  - network_uuid
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State
  - vm
  - vm_uuid

### vmware_ports_retrieve
GET /api/vmware-ports/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### vmware_ports_destroy
DELETE /api/vmware-ports/{uuid}/
Path parameters:
  - uuid

### vmware_ports_pull
POST /api/vmware-ports/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### vmware_ports_set_erred
POST /api/vmware-ports/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### vmware_ports_set_ok
POST /api/vmware-ports/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### vmware_ports_unlink
POST /api/vmware-ports/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

============================================================
## vmware-templates  (module: waldur_api_client.api.vmware_templates)
============================================================

### vmware_templates_list
GET /api/vmware-templates/
Query parameters (4):
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### vmware_templates_count
HEAD /api/vmware-templates/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (4):
  - name — Name
  - name_exact — Name (exact)
  - settings — Settings URL
  - settings_uuid — Settings UUID

### vmware_templates_retrieve
GET /api/vmware-templates/{uuid}/
Path parameters:
  - uuid

============================================================
## vmware-virtual-machine  (module: waldur_api_client.api.vmware_virtual_machine)
============================================================

### vmware_virtual_machine_list
GET /api/vmware-virtual-machine/
Query parameters (19):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - field
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - runtime_state
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### vmware_virtual_machine_count
HEAD /api/vmware-virtual-machine/
Summary: Get number of items in the collection matching the request parameters
Description: Get number of items in the collection matching the request parameters.
Query parameters (18):
  - backend_id — Backend ID
  - can_manage — Can manage
  - customer — Customer UUID
  - customer_abbreviation — Customer abbreviation
  - customer_name — Customer name
  - customer_native_name — Customer native name
  - customer_uuid — Customer UUID
  - description — Description
  - external_ip — External IP
  - name — Name
  - name_exact — Name (exact)
  - project — Project UUID
  - project_name — Project name
  - project_uuid — Project UUID
  - runtime_state
  - service_settings_name — Service settings name
  - service_settings_uuid — Service settings UUID
  - state — State

### vmware_virtual_machine_create
POST /api/vmware-virtual-machine/
Request body: yes

### vmware_virtual_machine_retrieve
GET /api/vmware-virtual-machine/{uuid}/
Path parameters:
  - uuid
Query parameters (1):
  - field

### vmware_virtual_machine_update
PUT /api/vmware-virtual-machine/{uuid}/
Path parameters:
  - uuid
Request body: yes

### vmware_virtual_machine_partial_update
PATCH /api/vmware-virtual-machine/{uuid}/
Path parameters:
  - uuid
Request body: yes

### vmware_virtual_machine_destroy
DELETE /api/vmware-virtual-machine/{uuid}/
Path parameters:
  - uuid

### vmware_virtual_machine_console_retrieve
GET /api/vmware-virtual-machine/{uuid}/console/
Summary: This endpoint provides access to Virtual Machine Remote Console aka VMRC
Description: This endpoint provides access to Virtual Machine Remote Console aka VMRC.
Path parameters:
  - uuid

### vmware_virtual_machine_create_disk
POST /api/vmware-virtual-machine/{uuid}/create_disk/
Path parameters:
  - uuid
Request body: yes

### vmware_virtual_machine_create_port
POST /api/vmware-virtual-machine/{uuid}/create_port/
Path parameters:
  - uuid
Request body: yes

### vmware_virtual_machine_pull
POST /api/vmware-virtual-machine/{uuid}/pull/
Summary: Synchronize resource state
Description: Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Path parameters:
  - uuid

### vmware_virtual_machine_reboot_guest
POST /api/vmware-virtual-machine/{uuid}/reboot_guest/
Path parameters:
  - uuid

### vmware_virtual_machine_reset
POST /api/vmware-virtual-machine/{uuid}/reset/
Path parameters:
  - uuid

### vmware_virtual_machine_set_erred
POST /api/vmware-virtual-machine/{uuid}/set_erred/
Summary: Mark resource as ERRED
Description: Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
Path parameters:
  - uuid
Request body: yes

### vmware_virtual_machine_set_ok
POST /api/vmware-virtual-machine/{uuid}/set_ok/
Summary: Mark resource as OK
Description: Manually transition the resource to OK state and clear error fields. Staff-only operation.
Path parameters:
  - uuid

### vmware_virtual_machine_shutdown_guest
POST /api/vmware-virtual-machine/{uuid}/shutdown_guest/
Path parameters:
  - uuid

### vmware_virtual_machine_start
POST /api/vmware-virtual-machine/{uuid}/start/
Path parameters:
  - uuid

### vmware_virtual_machine_stop
POST /api/vmware-virtual-machine/{uuid}/stop/
Path parameters:
  - uuid

### vmware_virtual_machine_suspend
POST /api/vmware-virtual-machine/{uuid}/suspend/
Path parameters:
  - uuid

### vmware_virtual_machine_unlink
POST /api/vmware-virtual-machine/{uuid}/unlink/
Summary: Unlink resource
Description: Delete resource from the database without scheduling operations on backend
        and without checking current state of the resource. It is intended to be used
        for removing resource stuck in transitioning state.
Path parameters:
  - uuid

### vmware_virtual_machine_web_console_retrieve
GET /api/vmware-virtual-machine/{uuid}/web_console/
Summary: This endpoint provides access to HTML Console aka WMKS
Description: This endpoint provides access to HTML Console aka WMKS.
Path parameters:
  - uuid
