Skip to content

Booking Resources

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/booking-resources/ List Booking Resources
GET /api/booking-resources/{uuid}/ Retrieve
Other Actions
POST /api/booking-resources/{uuid}/accept/ Accept
POST /api/booking-resources/{uuid}/reject/ Reject

Core CRUD

List Booking Resources

1
2
3
4
http \
  GET \
  https://api.example.com/api/booking-resources/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.booking_resource_field_enum import BookingResourceFieldEnum # (1)
from waldur_api_client.models.booking_resource_o_enum import BookingResourceOEnum # (2)
from waldur_api_client.models.order_state import OrderState # (3)
from waldur_api_client.models.resource_state import ResourceState # (4)
from waldur_api_client.api.booking_resources import booking_resources_list # (5)

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

for item in response:
    print(item)
  1. Model Source: BookingResourceFieldEnum
  2. Model Source: BookingResourceOEnum
  3. Model Source: OrderState
  4. Model Source: ResourceState
  5. API Source: booking_resources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { bookingResourcesList } from 'waldur-js-client';

try {
  const response = await bookingResourcesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
category_uuid string (uuid) Category UUID
component_count number Filter by exact number of components
connected_customer_uuid string (uuid)
created string (date-time) Created after
created_before string (date-time) Created before
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
downscaled boolean Downscaled
field array
flavor_name string Flavor name
has_terminate_date boolean Has termination date
image_name string Image name
is_attached boolean Filter by attached state
lexis_links_supported boolean LEXIS links supported
limit_based boolean Filter by limit-based offerings
limit_component_count number Filter by exact number of limit-based components
modified string (date-time) Modified after
modified_before string (date-time) Modified before
name string Name
name_exact string Name (exact)
o array Ordering

offering string (uri)
offering_billable boolean Offering billable
offering_shared boolean Offering shared
offering_slug array Multiple values may be separated by commas.
offering_type string Offering type
offering_uuid array Multiple values may be separated by commas.
only_limit_based boolean Filter resources with only limit-based components
only_usage_based boolean Filter resources with only usage-based components
order_state array Order state

page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)
paused boolean Paused
plan_uuid string (uuid) Plan UUID
project_name string Project name
project_uuid string (uuid) Project UUID
provider_uuid string (uuid) Provider UUID
query string Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
resource_attributes string Resource attributes (JSON)
restrict_member_access boolean Restrict member access
runtime_state string Runtime state
service_manager_uuid string (uuid) Service manager UUID
slug string Slug
state array Resource state

usage_based boolean Filter by usage-based offerings
visible_to_providers boolean Include only resources visible to service providers
visible_to_username string Visible to username

200 -

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

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options object (free-form) Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
provider_description string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_start_date string (date)
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_effective_end_date string (date) Effective project end date including grace period. After this date, resources are terminated, except resources of offerings that disable the grace period — those are terminated on the raw project end date.
resource_effective_end_date string (date) The date this resource is scheduled to terminate: the earliest of its own end date and the project-driven termination date (the raw project end date if the offering disables the grace period, otherwise the effective with-grace end date).
project_is_in_grace_period boolean True if the project is past its end date but still within the grace period.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource bills any component by usage under its plan.
is_limit_based boolean Returns True if the resource bills any component on user-adjustable limits under its plan.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
end_date_updated_at string (date-time) Timestamp of the last end_date change.
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. Sums the ComponentUsage rows of the component's current period (the monthly billing period unless the component defines a longer limit_period), i.e. the period's high-watermark rather than the instantaneous current_usages value.
downscaled boolean
restrict_member_access boolean
paused boolean
usage_limit_restriction any Which restriction (paused or downscaled) was automatically applied because reported usage reached a component limit. Empty when no such restriction is active. Used so the automatic lift never clears a restriction that was set for another reason.
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options object (free-form)
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.offering_uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount number (double)
offering_components.limit_decimal_places integer Number of decimal places accepted for this component's limit. 0 keeps the limit integer-only.
offering_components.article_code string
offering_components.max_value number (double)
offering_components.min_value number (double)
offering_components.max_available_limit number (double)
offering_components.is_boolean boolean
offering_components.default_limit number (double)
offering_components.factor integer
offering_components.is_builtin boolean The API's older name for billed_per_plan. It used to ask the plugin registry whether this component's type is one the plugin declares, which left out the OpenStack per-volume-type quotas: they are created by the volume type sync rather than declared, so the API called them provider components while the billing resolver treated them as builtin. Reading the stored flag makes the two agree.
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer
offering_components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
offering_components.min_renewal_duration integer Minimum number of months allowed for a renewal.
offering_components.max_renewal_duration integer Maximum number of months allowed for a renewal.
offering_components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
has_api_keys boolean Whether the resource owns any API keys, so the portal can offer key management without knowing which backend serves the resource.
offering_account_settings any
created_by string (uri)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string
consumer_reviewed_by string (uri)
consumer_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_by_full_name string
slots array of objects
slots.start string (date-time)
slots.end string (date-time)
slots.backend_id string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/booking-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.booking_resource_field_enum import BookingResourceFieldEnum # (1)
from waldur_api_client.api.booking_resources import booking_resources_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = booking_resources_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: BookingResourceFieldEnum
  2. API Source: booking_resources_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { bookingResourcesRetrieve } from 'waldur-js-client';

try {
  const response = await bookingResourcesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options object (free-form) Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
provider_description string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_start_date string (date)
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_effective_end_date string (date) Effective project end date including grace period. After this date, resources are terminated, except resources of offerings that disable the grace period — those are terminated on the raw project end date.
resource_effective_end_date string (date) The date this resource is scheduled to terminate: the earliest of its own end date and the project-driven termination date (the raw project end date if the offering disables the grace period, otherwise the effective with-grace end date).
project_is_in_grace_period boolean True if the project is past its end date but still within the grace period.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource bills any component by usage under its plan.
is_limit_based boolean Returns True if the resource bills any component on user-adjustable limits under its plan.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
end_date_updated_at string (date-time) Timestamp of the last end_date change.
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. Sums the ComponentUsage rows of the component's current period (the monthly billing period unless the component defines a longer limit_period), i.e. the period's high-watermark rather than the instantaneous current_usages value.
downscaled boolean
restrict_member_access boolean
paused boolean
usage_limit_restriction any Which restriction (paused or downscaled) was automatically applied because reported usage reached a component limit. Empty when no such restriction is active. Used so the automatic lift never clears a restriction that was set for another reason.
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options object (free-form)
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.offering_uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount number (double)
offering_components.limit_decimal_places integer Number of decimal places accepted for this component's limit. 0 keeps the limit integer-only.
offering_components.article_code string
offering_components.max_value number (double)
offering_components.min_value number (double)
offering_components.max_available_limit number (double)
offering_components.is_boolean boolean
offering_components.default_limit number (double)
offering_components.factor integer
offering_components.is_builtin boolean The API's older name for billed_per_plan. It used to ask the plugin registry whether this component's type is one the plugin declares, which left out the OpenStack per-volume-type quotas: they are created by the volume type sync rather than declared, so the API called them provider components while the billing resolver treated them as builtin. Reading the stored flag makes the two agree.
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer
offering_components.prepaid_duration_step integer Step size in months for the initial prepaid duration at order creation. If set, only multiples of this value (starting from min_prepaid_duration) are valid. Defaults to 1 (any value between min and max).
offering_components.min_renewal_duration integer Minimum number of months allowed for a renewal.
offering_components.max_renewal_duration integer Maximum number of months allowed for a renewal.
offering_components.renewal_duration_step integer Step size in months for renewal. Only multiples of this value (starting from min_renewal_duration) are valid. Defaults to 1.
has_api_keys boolean Whether the resource owns any API keys, so the portal can offer key management without knowing which backend serves the resource.
offering_account_settings any
created_by string (uri)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string
consumer_reviewed_by string (uri)
consumer_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_by_full_name string
slots array of objects
slots.start string (date-time)
slots.end string (date-time)
slots.backend_id string

Other Actions

Accept

1
2
3
4
http \
  POST \
  https://api.example.com/api/booking-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/accept/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.booking_resources import booking_resources_accept # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = booking_resources_accept.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

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

try {
  const response = await bookingResourcesAccept({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
order_uuid string (uuid)

Reject

1
2
3
4
http \
  POST \
  https://api.example.com/api/booking-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reject/ \
  Authorization:"Token YOUR_API_TOKEN"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.booking_resources import booking_resources_reject # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = booking_resources_reject.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

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

try {
  const response = await bookingResourcesReject({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
order_uuid string (uuid)