Skip to content

Marketplace Resources

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-resources/ List consumer resources
GET /api/marketplace-resources/{uuid}/ Retrieve a consumer resource
POST /api/marketplace-resources/{uuid}/pull/ Pull resource data
POST /api/marketplace-resources/{uuid}/unlink/ Unlink a resource (staff only)
PUT /api/marketplace-resources/{uuid}/ Update a consumer resource
PATCH /api/marketplace-resources/{uuid}/ Partially update a consumer resource
State Management
POST /api/marketplace-resources/{uuid}/set_downscaled/ Set downscaled flag for resource
POST /api/marketplace-resources/{uuid}/set_paused/ Set paused flag for resource
POST /api/marketplace-resources/{uuid}/terminate/ Terminate a resource
Configuration & Updates
POST /api/marketplace-resources/{uuid}/move_resource/ Move a resource to another project
POST /api/marketplace-resources/{uuid}/renew/ Renew a prepaid resource
POST /api/marketplace-resources/{uuid}/set_end_date_by_staff/ Set end date of the resource by staff
POST /api/marketplace-resources/{uuid}/set_restrict_member_access/ Set restrict member access flag
POST /api/marketplace-resources/{uuid}/set_slug/ Set resource slug
POST /api/marketplace-resources/{uuid}/switch_plan/ Switch resource plan
POST /api/marketplace-resources/{uuid}/update_limits/ Update resource limits
POST /api/marketplace-resources/{uuid}/update_options/ Update resource options
Data & Reporting
GET /api/marketplace-resources/{uuid}/details/ Get resource details
GET /api/marketplace-resources/{uuid}/glauth_users_config/ Get GLauth user configuration for a resource
GET /api/marketplace-resources/{uuid}/offering_for_subresources/ List offerings for sub-resources
GET /api/marketplace-resources/{uuid}/offering/ Get offering details
GET /api/marketplace-resources/{uuid}/plan_periods/ List resource plan periods
GET /api/marketplace-resources/{uuid}/team/ Get resource team
Naming
POST /api/marketplace-resources/suggest_name/ Suggest a resource name
Other Actions
GET /api/marketplace-resources/{uuid}/history/at/ Get object state at a specific timestamp
GET /api/marketplace-resources/{uuid}/history/ Get version history
POST /api/marketplace-resources/{uuid}/estimate_renewal/ Estimate renewal cost breakdown
POST /api/marketplace-resources/{uuid}/reallocate_limits/ Reallocate resource limits
POST /api/marketplace-resources/{uuid}/restore/ Restore
POST /api/marketplace-resources/{uuid}/set_end_date/ Set end date of the resource

Core CRUD

List consumer resources

Returns a paginated list of resources accessible to the current user as a service consumer.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-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.order_state import OrderState # (1)
from waldur_api_client.models.resource_field_enum import ResourceFieldEnum # (2)
from waldur_api_client.models.resource_o_enum import ResourceOEnum # (3)
from waldur_api_client.models.resource_state import ResourceState # (4)
from waldur_api_client.api.marketplace_resources import marketplace_resources_list # (5)

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

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

try {
  const response = await marketplaceResourcesList({
  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
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
has_terminate_date boolean Has termination date
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
scope string (uri) Filter by scope URL.
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 any 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_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 will be terminated.
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 has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
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)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
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 any
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 integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
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.

Retrieve a consumer resource

Returns details of a specific resource accessible to the consumer.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-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.resource_field_enum import ResourceFieldEnum # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_retrieve # (2)

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

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

try {
  const response = await marketplaceResourcesRetrieve({
  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 any 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_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 will be terminated.
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 has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
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)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
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 any
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 integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
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.

Pull resource data

Schedules a task to pull the latest data for the resource from its backend.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  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.marketplace_resources import marketplace_resources_pull # (1)

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

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

try {
  const response = await marketplaceResourcesPull({
  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) ✓

202 -

Field Type
detail string

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.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  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.marketplace_resources import marketplace_resources_unlink # (1)

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

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

try {
  const response = await marketplaceResourcesUnlink({
  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) ✓

204 - No response body

403 - No response body

Update a consumer resource

Updates the name, description, or end date of a resource.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-resource"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_update_request import ResourceUpdateRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_update # (2)

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

body_data = ResourceUpdateRequest(
    name="my-awesome-marketplace-resource"
)
response = marketplace_resources_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceUpdateRequest
  2. API Source: marketplace_resources_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-resource"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

200 -

Field Type Description
name string
description string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

Partially update a consumer resource

Partially updates the name, description, or end date of a resource.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_resource_update_request import PatchedResourceUpdateRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_partial_update # (2)

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

body_data = PatchedResourceUpdateRequest()
response = marketplace_resources_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceResourcesPartialUpdate({
  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) ✓
Field Type Required Description
name string
description string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

200 -

Field Type Description
name string
description string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

State Management

Set downscaled flag for resource

Sets the 'downscaled' flag for a resource. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_downscaled/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_downscaled_request import ResourceDownscaledRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_set_downscaled # (2)

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

body_data = ResourceDownscaledRequest()
response = marketplace_resources_set_downscaled.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceResourcesSetDownscaled({
  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) ✓
Field Type Required
downscaled boolean

200 -

Field Type
status string

Set paused flag for resource

Sets the 'paused' flag for a resource. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_paused/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_paused_request import ResourcePausedRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_set_paused # (2)

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

body_data = ResourcePausedRequest()
response = marketplace_resources_set_paused.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceResourcesSetPaused({
  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) ✓
Field Type Required
paused boolean

200 -

Field Type
status string

Terminate a resource

Creates a marketplace order to terminate the resource. This action is asynchronous and may require approval.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/terminate/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_terminate_request import ResourceTerminateRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_terminate # (2)

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

body_data = ResourceTerminateRequest()
response = marketplace_resources_terminate.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceResourcesTerminate({
  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) ✓
Field Type Required Description
attributes any Optional attributes/parameters to pass to the termination operation

200 -

Field Type Description
order_uuid string (uuid) UUID of the created or updated order

Configuration & Updates

Move a resource to another project

Moves a resource and its associated data to a different project. Requires staff permissions.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/move_resource/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.move_resource_request import MoveResourceRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_move_resource # (2)

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

body_data = MoveResourceRequest(
    project=null
)
response = marketplace_resources_move_resource.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MoveResourceRequest
  2. API Source: marketplace_resources_move_resource
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesMoveResource } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesMoveResource({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "project": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
project any ✓ Target project URL where the resource should be moved
Constraints: write-only

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 any 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_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 will be terminated.
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 has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
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)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
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 any
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 integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
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.

Renew a prepaid resource

Creates a renewal order to extend the subscription period of a prepaid resource. Optionally, limits can be upgraded at the same time.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/renew/ \
  Authorization:"Token YOUR_API_TOKEN" \
  extension_months=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_renew_request import ResourceRenewRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_renew # (2)

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

body_data = ResourceRenewRequest(
    extension_months=123
)
response = marketplace_resources_renew.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceRenewRequest
  2. API Source: marketplace_resources_renew
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesRenew } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesRenew({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "extension_months": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
extension_months integer ✓ Number of months to extend the subscription by.
limits object (free-form) Optional new limits for the resource. Supports upgrades only.
request_comment string Optional comment for the renewal request.
attachment string (binary) Optional PDF attachment for the renewal request.

200 -

Field Type Description
order_uuid string (uuid) UUID of the created or updated order

Set end date of the resource by staff

Deprecated: Use set_end_date instead. Allows a staff user to set or update the end date for a resource.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_end_date_by_staff/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_end_date_by_provider_request import ResourceEndDateByProviderRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_set_end_date_by_staff # (2)

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

body_data = ResourceEndDateByProviderRequest()
response = marketplace_resources_set_end_date_by_staff.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceResourcesSetEndDateByStaff({
  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) ✓
Field Type Required Description
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

200 - No response body

Set restrict member access flag

Sets the 'restrict_member_access' flag for a resource. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_restrict_member_access/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_restrict_member_access_request import ResourceRestrictMemberAccessRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_set_restrict_member_access # (2)

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

body_data = ResourceRestrictMemberAccessRequest()
response = marketplace_resources_set_restrict_member_access.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceResourcesSetRestrictMemberAccess({
  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) ✓
Field Type Required
restrict_member_access boolean

200 -

Field Type
status string

Set resource slug

Updates the slug for a resource. Requires staff permissions.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_slug/ \
  Authorization:"Token YOUR_API_TOKEN" \
  slug="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_slug_request import ResourceSlugRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_set_slug # (2)

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

body_data = ResourceSlugRequest(
    slug="string-value"
)
response = marketplace_resources_set_slug.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceSlugRequest
  2. API Source: marketplace_resources_set_slug
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesSetSlug } from 'waldur-js-client';

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

200 -

Field Type
status string

Switch resource plan

Creates a marketplace order to switch the billing plan for a resource. This action is asynchronous and may require approval.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/switch_plan/ \
  Authorization:"Token YOUR_API_TOKEN" \
  plan="https://api.example.com/api/plan/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_switch_plan_request import ResourceSwitchPlanRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_switch_plan # (2)

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

body_data = ResourceSwitchPlanRequest(
    plan="https://api.example.com/api/plan/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_resources_switch_plan.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceSwitchPlanRequest
  2. API Source: marketplace_resources_switch_plan
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesSwitchPlan } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesSwitchPlan({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "plan": "https://api.example.com/api/plan/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
plan string (uri) ✓

200 -

Field Type Description
order_uuid string (uuid) UUID of the created or updated order

Update resource limits

Creates a marketplace order to update the limits (e.g., CPU, RAM) for a resource. This action is asynchronous and may require approval.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_limits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  limits:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_update_limits_request import ResourceUpdateLimitsRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_update_limits # (2)

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

body_data = ResourceUpdateLimitsRequest(
    limits={}
)
response = marketplace_resources_update_limits.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceUpdateLimitsRequest
  2. API Source: marketplace_resources_update_limits
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesUpdateLimits } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesUpdateLimits({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "limits": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
limits object (free-form) ✓
request_comment string
attachment string (binary) Optional PDF attachment for the limit update request.

200 -

Field Type Description
order_uuid string (uuid) UUID of the created or updated order

Update resource options

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.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_options/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_options_request import ResourceOptionsRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_update_options # (2)

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

body_data = ResourceOptionsRequest()
response = marketplace_resources_update_options.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceResourcesUpdateOptions({
  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) ✓
Field Type Required
options any

200 -

Field Type Description
status string Status of the resource response

201 -

Field Type Description
order_uuid string (uuid) UUID of the created or updated order

409 - No response body

Data & Reporting

Get resource details

Returns the detailed representation of the backend resource associated with the marketplace resource. The format of the response depends on the resource type.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/details/ \
  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.marketplace_resources import marketplace_resources_details_retrieve # (1)

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

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

try {
  const response = await marketplaceResourcesDetailsRetrieve({
  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 -

204 -

404 -

Get GLauth user configuration for a resource

1
2
    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.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/glauth_users_config/ \
  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.marketplace_resources import marketplace_resources_glauth_users_config_retrieve # (1)

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

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

try {
  const response = await marketplaceResourcesGlauthUsersConfigRetrieve({
  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 -

List offerings for sub-resources

Returns a list of offerings that can be provisioned as sub-resources of the current resource.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offering_for_subresources/ \
  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.api.marketplace_resources import marketplace_resources_offering_for_subresources_list # (1)

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

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

try {
  const response = await marketplaceResourcesOfferingForSubresourcesList({
  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 -

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

Field Type Description
uuid string (uuid) UUID of the offering
type string Type of the offering

Get offering details

Returns details of the offering connected to the requested object.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offering/ \
  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.marketplace_resources import marketplace_resources_offering_retrieve # (1)

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

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

try {
  const response = await marketplaceResourcesOfferingRetrieve({
  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 Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
helpdesk_url string (uri)
documentation_url string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_arch string CPU architecture of the partition (e.g., x86_64/amd/zen3)
partitions.gpu_arch string GPU architecture of the partition (e.g., nvidia/cc90, amd/gfx90a)
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.offering_uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
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).
components.min_renewal_duration integer Minimum number of months allowed for a renewal.
components.max_renewal_duration integer Maximum number of months allowed for a renewal.
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.
plugin_options any
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.components.discounted_price string (decimal)
plans.components.discount_description string
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price string
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
effective_available_limits array of strings
compliance_checklist string (uri)
user_has_consent boolean
is_accessible boolean
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.
promotion_campaigns array of objects
promotion_campaigns.uuid string (uuid)
promotion_campaigns.name string
promotion_campaigns.start_date string (date) Starting from this date, the campaign is active.
promotion_campaigns.end_date string (date) The last day the campaign is active.
promotion_campaigns.discount_type string
Enum: discount, special_price
promotion_campaigns.discount integer
promotion_campaigns.stock integer
promotion_campaigns.description string
promotion_campaigns.months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
promotion_campaigns.service_provider string (uri)

List resource plan periods

Returns a list of active and future plan periods for the resource. Each period includes the plan details and current component usage.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/plan_periods/ \
  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.api.marketplace_resources import marketplace_resources_plan_periods_list # (1)

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

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

try {
  const response = await marketplaceResourcesPlanPeriodsList({
  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 -

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

Field Type Description
uuid string (uuid)
plan_name string
plan_uuid string (uuid)
start string (date-time)
end string (date-time)
components array of objects
components.uuid string (uuid)
components.created string (date-time)
components.description string
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.measured_unit string Unit of measurement, for example, GB.
components.usage string (decimal)
components.date string (date-time)
components.recurring boolean Reported value is reused every month until changed.

Get resource team

Returns a list of users connected to the project of this resource, including their project roles and offering-specific usernames.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/team/ \
  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.api.marketplace_resources import marketplace_resources_team_list # (1)

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

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

try {
  const response = await marketplaceResourcesTeamList({
  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 Description
has_consent boolean When true, return only users who have active consent for this offering.

200 -

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

Field Type Description
url string (uri)
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
full_name string
email string (email)
role string
expiration_time string (date-time)
offering_user_username string
offering_user_state any

Naming

Suggest a resource name

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}, {offering_slug}, {plan_name}, {counter}, and {attributes[KEY]} for any order form value.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-resources/suggest_name/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_suggest_name_request import ResourceSuggestNameRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_suggest_name # (2)

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

body_data = ResourceSuggestNameRequest(
    project="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_resources_suggest_name.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceResourcesSuggestName({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "project": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
project string (uuid) ✓
offering string (uuid) ✓
plan string (uuid)
attributes any

200 -

Field Type
name string

Other Actions

Get object state at a specific timestamp

Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/at/ \
  Authorization:"Token YOUR_API_TOKEN" \
  timestamp=="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resources import marketplace_resources_history_at_retrieve # (1)

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

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

try {
  const response = await marketplaceResourcesHistoryAtRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "timestamp": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Required Description
timestamp string ✓ ISO 8601 timestamp to query the object state at

200 -

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

400 -

404 -

Get version history

Returns the version history for this object. Only accessible by staff and support users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_state import OrderState # (1)
from waldur_api_client.models.resource_o_enum import ResourceOEnum # (2)
from waldur_api_client.models.resource_state import ResourceState # (3)
from waldur_api_client.api.marketplace_resources import marketplace_resources_history_list # (4)

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

for item in response:
    print(item)
  1. Model Source: OrderState
  2. Model Source: ResourceOEnum
  3. Model Source: ResourceState
  4. API Source: marketplace_resources_history_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesHistoryList } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesHistoryList({
  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 Description
backend_id string Backend ID
category_uuid string (uuid) Category UUID
component_count number Filter by exact number of components
created string (date-time) Created after
created_after string Filter versions created after this timestamp (ISO 8601)
created_before string Filter versions created before this timestamp (ISO 8601)
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
downscaled boolean Downscaled
has_terminate_date boolean Has termination date
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
scope string (uri) Filter by scope URL.
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
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

Estimate renewal cost breakdown

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/estimate_renewal/ \
  Authorization:"Token YOUR_API_TOKEN" \
  extension_months=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.renewal_estimate_request_request import RenewalEstimateRequestRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_estimate_renewal # (2)

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

body_data = RenewalEstimateRequestRequest(
    extension_months=123
)
response = marketplace_resources_estimate_renewal.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RenewalEstimateRequestRequest
  2. API Source: marketplace_resources_estimate_renewal
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesEstimateRenewal } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesEstimateRenewal({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "extension_months": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
extension_months integer ✓
limits object (free-form)

200 -

Field Type
components array of objects
components.component_type string
components.component_name string
components.billing_type string
components.billing_period string
components.current_limit integer
components.new_limit integer
components.unit_price string (decimal)
components.measured_unit string
components.period_description string
components.total string (decimal)
subscription_total string (decimal)
limit_change_total string (decimal)
total string (decimal)
remaining_days integer
new_end_date string (date)

Reallocate resource limits

Creates marketplace orders to reallocate limits from source resource to target resources.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reallocate_limits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  limits:='{}' \
  targets:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_reallocate_limits_request import ResourceReallocateLimitsRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_reallocate_limits # (2)

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

body_data = ResourceReallocateLimitsRequest(
    limits={},
    targets=[]
)
response = marketplace_resources_reallocate_limits.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceReallocateLimitsRequest
  2. API Source: marketplace_resources_reallocate_limits
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceResourcesReallocateLimits } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesReallocateLimits({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "limits": {},
    "targets": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
limits object (free-form) ✓
targets array of objects ✓
targets.resource_uuid string (uuid) ✓
targets.allocated_limits object (free-form) ✓

200 -

Field Type Description
source_order_uuid string (uuid) UUID of the source order for limit reallocation
target_order_uuids array of string (uuid)s List of UUIDs for target orders receiving the reallocated limits

Restore

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restore/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  name="my-awesome-marketplace-resource"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_request import ResourceRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_restore # (2)

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

body_data = ResourceRequest(
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    name="my-awesome-marketplace-resource"
)
response = marketplace_resources_restore.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceRequest
  2. API Source: marketplace_resources_restore
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceResourcesRestore } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesRestore({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "name": "my-awesome-marketplace-resource"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
offering string (uri) ✓
plan string (uri)
name string ✓
slug string URL-friendly identifier. Only editable by staff users.
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
downscaled boolean
paused boolean

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 any 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_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 will be terminated.
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 has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
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)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
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 any
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 integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
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.

Set end date of the resource

Allows a consumer (customer owner) to set or update the end date for a resource.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_end_date/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_end_date_request import ResourceEndDateRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_set_end_date # (2)

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

body_data = ResourceEndDateRequest()
response = marketplace_resources_set_end_date.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceResourcesSetEndDate({
  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) ✓
Field Type Required Description
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

200 - No response body