Marketplace Provider Resources

Operations Summary

Method	Endpoint	Description
Core CRUD
GET	/api/marketplace-provider-resources/	List provider resources
GET	/api/marketplace-provider-resources/{uuid}/	Retrieve a provider resource
POST	/api/marketplace-provider-resources/{uuid}/pull/	Pull resource data
POST	/api/marketplace-provider-resources/{uuid}/unlink/	Unlink a resource (staff only)
POST	/api/marketplace-provider-resources/{uuid}/update_options/	Update resource options
POST	/api/marketplace-provider-resources/{uuid}/update_options_direct/	Update resource options directly
PUT	/api/marketplace-provider-resources/{uuid}/	Update a provider resource
PATCH	/api/marketplace-provider-resources/{uuid}/	Partially update a provider resource
Other Actions
GET	/api/marketplace-provider-resources/{uuid}/details/	Get resource details
GET	/api/marketplace-provider-resources/{uuid}/glauth_users_config/	Get GLauth user configuration for a resource
GET	/api/marketplace-provider-resources/{uuid}/offering_for_subresources/	List offerings for sub-resources
GET	/api/marketplace-provider-resources/{uuid}/offering/	Get offering details
GET	/api/marketplace-provider-resources/{uuid}/plan_periods/	List resource plan periods
GET	/api/marketplace-provider-resources/{uuid}/team/	Get resource team
POST	/api/marketplace-provider-resources/{uuid}/move_resource/	Move a resource to another project
POST	/api/marketplace-provider-resources/{uuid}/refresh_last_sync/	Refresh last sync time
POST	/api/marketplace-provider-resources/{uuid}/restore/	Restore
POST	/api/marketplace-provider-resources/{uuid}/set_as_erred/	Set resource state to erred
POST	/api/marketplace-provider-resources/{uuid}/set_as_ok/	Set resource state to OK
POST	/api/marketplace-provider-resources/{uuid}/set_backend_id/	Set resource backend ID
POST	/api/marketplace-provider-resources/{uuid}/set_backend_metadata/	Set resource backend metadata
POST	/api/marketplace-provider-resources/{uuid}/set_downscaled/	Set downscaled flag for resource
POST	/api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/	Set end date by provider
POST	/api/marketplace-provider-resources/{uuid}/set_end_date_by_staff/	Set end date of the resource by staff
POST	/api/marketplace-provider-resources/{uuid}/set_limits/	Set resource limits
POST	/api/marketplace-provider-resources/{uuid}/set_paused/	Set paused flag for resource
POST	/api/marketplace-provider-resources/{uuid}/set_restrict_member_access/	Set restrict member access flag
POST	/api/marketplace-provider-resources/{uuid}/set_slug/	Set resource slug
POST	/api/marketplace-provider-resources/{uuid}/submit_report/	Submit a report for a resource
POST	/api/marketplace-provider-resources/{uuid}/terminate/	Terminate a resource

---

Core CRUD

List provider resources

Returns a paginated list of resources for offerings managed by the current user as a service provider.

HTTPiePythonTypeScriptQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_list # (1)

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

for item in response:
    print(item)

1. API Source: marketplace_provider_resources_list

import { marketplaceProviderResourcesList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesList({
  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
customer	string	Customer URL
customer_uuid	string (uuid)	Customer UUID
downscaled	boolean	Downscaled
exclude_pending_transitional	boolean	Exclude transitional resources with early pending orders
field	array
has_terminate_date	boolean	Has termination date
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
name	string	Name
name_exact	string	Name (exact)
o	array	Ordering
offering	string
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
restrict_member_access	boolean	Restrict member access
runtime_state	string	Runtime state
service_manager_uuid	string (uuid)	Service manager UUID
state	array	Resource state
usage_based	boolean	Filter by usage-based offerings
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
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_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
parent_uuid	string (uuid)
parent_name	string
backend_metadata	any
is_usage_based	boolean
is_limit_based	boolean
name	string
slug	string
current_usages	object (free-form)
can_terminate	boolean
report	array of objects
report.header	string
report.body	string
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)
downscaled	boolean
restrict_member_access	boolean
paused	boolean
endpoints	array of objects
endpoints.uuid	string (uuid)
endpoints.name	string
endpoints.url	string
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)

---

Retrieve a provider resource

Returns details of a specific resource from a provider's perspective.

HTTPiePythonTypeScriptPath ParametersQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_retrieve # (1)

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

print(response)

1. API Source: marketplace_provider_resources_retrieve

import { marketplaceProviderResourcesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesRetrieve({
  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
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_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
parent_uuid	string (uuid)
parent_name	string
backend_metadata	any
is_usage_based	boolean
is_limit_based	boolean
name	string
slug	string
current_usages	object (free-form)
can_terminate	boolean
report	array of objects
report.header	string
report.body	string
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)
downscaled	boolean
restrict_member_access	boolean
paused	boolean
endpoints	array of objects
endpoints.uuid	string (uuid)
endpoints.name	string
endpoints.url	string
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)

---

Pull resource data

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

HTTPiePythonTypeScriptPath ParametersResponses

http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_pull # (1)

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

print(response)

1. API Source: marketplace_provider_resources_pull

import { marketplaceProviderResourcesPull } from 'waldur-js-client';

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

---

Unlink a resource (staff only)

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.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_unlink # (1)

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

print(response)

1. API Source: marketplace_provider_resources_unlink

import { marketplaceProviderResourcesUnlink } from 'waldur-js-client';

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

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_options_request import ResourceOptionsRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_update_options # (2)

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

body_data = ResourceOptionsRequest()
response = marketplace_provider_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_provider_resources_update_options

import { marketplaceProviderResourcesUpdateOptions } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesUpdateOptions({
  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
status	string

---

201 -

Field	Type
order_uuid	string (uuid)

---

Update resource options directly

Allows a service provider to directly update the options of a resource without creating an order. This is typically used for administrative changes or backend synchronization.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_options_direct/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_options_request import ResourceOptionsRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_update_options_direct # (2)

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

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

print(response)

1. Model Source: ResourceOptionsRequest
2. API Source: marketplace_provider_resources_update_options_direct

import { marketplaceProviderResourcesUpdateOptionsDirect } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesUpdateOptionsDirect({
  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
status	string

---

Update a provider resource

Updates the name or description of a resource. Requires provider permissions.

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_update_request import ResourceUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_update # (2)

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

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

print(response)

1. Model Source: ResourceUpdateRequest
2. API Source: marketplace_provider_resources_update

import { marketplaceProviderResourcesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-provider-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 provider resource

Partially updates the name or description of a resource. Requires provider permissions.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

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

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_provider_resources import marketplace_provider_resources_partial_update # (2)

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

body_data = PatchedResourceUpdateRequest()
response = marketplace_provider_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_provider_resources_partial_update

import { marketplaceProviderResourcesPartialUpdate } from 'waldur-js-client';

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

---

Other Actions

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.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/details/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_details_retrieve # (1)

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

print(response)

1. API Source: marketplace_provider_resources_details_retrieve

import { marketplaceProviderResourcesDetailsRetrieve } from 'waldur-js-client';

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

    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.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/glauth_users_config/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_glauth_users_config_retrieve # (1)

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

print(response)

1. API Source: marketplace_provider_resources_glauth_users_config_retrieve

import { marketplaceProviderResourcesGlauthUsersConfigRetrieve } from 'waldur-js-client';

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

HTTPiePythonTypeScriptPath ParametersResponses

http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offering_for_subresources/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_offering_for_subresources_list # (1)

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

for item in response:
    print(item)

1. API Source: marketplace_provider_resources_offering_for_subresources_list

import { marketplaceProviderResourcesOfferingForSubresourcesList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesOfferingForSubresourcesList({
  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
uuid	string (uuid)
type	string

---

Get offering details

Returns details of the offering connected to the requested object.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offering/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_offering_retrieve # (1)

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

print(response)

1. API Source: marketplace_provider_resources_offering_retrieve

import { marketplaceProviderResourcesOfferingRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesOfferingRetrieve({
  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
description	string
full_description	string
privacy_policy_link	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
software_catalogs	array of objects
software_catalogs.uuid	string (uuid)
software_catalogs.catalog	object
software_catalogs.catalog.uuid	string
software_catalogs.catalog.name	string
software_catalogs.catalog.version	string
software_catalogs.catalog.description	string
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	object
software_catalogs.partition.uuid	string
software_catalogs.partition.partition_name	string
software_catalogs.partition.priority_tier	integer
software_catalogs.partition.qos	string
partitions	array of objects
partitions.uuid	string (uuid)
partitions.partition_name	string	Name of the SLURM partition
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.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
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)
plans.organization_groups.parent_name	string
plans.organization_groups.parent	string (uri)
plans.organization_groups.customers_count	integer
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.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	number (double)
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 (uuid)
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
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)
organization_groups.parent_name	string
organization_groups.parent	string (uri)
organization_groups.customers_count	integer
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'.
compliance_checklist	string (uri)
user_has_consent	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.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/plan_periods/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_plan_periods_list # (1)

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

for item in response:
    print(item)

1. API Source: marketplace_provider_resources_plan_periods_list

import { marketplaceProviderResourcesPlanPeriodsList } from 'waldur-js-client';

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

HTTPiePythonTypeScriptPath ParametersResponses

http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/team/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_team_list # (1)

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

for item in response:
    print(item)

1. API Source: marketplace_provider_resources_team_list

import { marketplaceProviderResourcesTeamList } from 'waldur-js-client';

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

---

Move a resource to another project

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

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.move_resource_request import MoveResourceRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_move_resource # (2)

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

body_data = MoveResourceRequest(
    project=null
)
response = marketplace_provider_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_provider_resources_move_resource

import { marketplaceProviderResourcesMoveResource } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesMoveResource({
  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
project	any	✓

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
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_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
parent_uuid	string (uuid)
parent_name	string
backend_metadata	any
is_usage_based	boolean
is_limit_based	boolean
name	string
slug	string
current_usages	object (free-form)
can_terminate	boolean
report	array of objects
report.header	string
report.body	string
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)
downscaled	boolean
restrict_member_access	boolean
paused	boolean
endpoints	array of objects
endpoints.uuid	string (uuid)
endpoints.name	string
endpoints.url	string
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)

---

Refresh last sync time

Updates the 'last_sync' timestamp for a resource to the current time. This is useful for backend agents to signal that a resource is being actively monitored.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/refresh_last_sync/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_refresh_last_sync # (1)

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

print(response)

1. API Source: marketplace_provider_resources_refresh_last_sync

import { marketplaceProviderResourcesRefreshLastSync } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesRefreshLastSync({
  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 - No response body

---

Restore

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/marketplace-provider-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-provider-resource"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_request import ResourceRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_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-provider-resource"
)
response = marketplace_provider_resources_restore.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)

1. Model Source: ResourceRequest
2. API Source: marketplace_provider_resources_restore

import { marketplaceProviderResourcesRestore } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesRestore({
  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-provider-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
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
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_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
parent_uuid	string (uuid)
parent_name	string
backend_metadata	any
is_usage_based	boolean
is_limit_based	boolean
name	string
slug	string
current_usages	object (free-form)
can_terminate	boolean
report	array of objects
report.header	string
report.body	string
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)
downscaled	boolean
restrict_member_access	boolean
paused	boolean
endpoints	array of objects
endpoints.uuid	string (uuid)
endpoints.name	string
endpoints.url	string
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)

---

Set resource state to erred

Allows a service provider to manually set the state of a resource to 'erred'. An error message and traceback can be provided.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_as_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_set_state_erred_request import ResourceSetStateErredRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_as_erred # (2)

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

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

print(response)

1. Model Source: ResourceSetStateErredRequest
2. API Source: marketplace_provider_resources_set_as_erred

import { marketplaceProviderResourcesSetAsErred } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetAsErred({
  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
error_message	string
error_traceback	string

200 - No response body

---

Set resource state to OK

Allows a service provider to manually set the state of a resource to 'OK', clearing any previous error messages.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_as_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_as_ok # (1)

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

print(response)

1. API Source: marketplace_provider_resources_set_as_ok

import { marketplaceProviderResourcesSetAsOk } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetAsOk({
  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 - No response body

---

Set resource backend ID

Allows a service provider to set or update the backend ID for a resource, linking it to an external system's identifier.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_backend_id/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_backend_id_request import ResourceBackendIDRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_backend_id # (2)

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

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

print(response)

1. Model Source: ResourceBackendIDRequest
2. API Source: marketplace_provider_resources_set_backend_id

import { marketplaceProviderResourcesSetBackendId } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetBackendId({
  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
backend_id	string

200 -

Field	Type
status	string

---

Set resource backend metadata

Allows a service provider to set or update the backend-specific metadata for a resource.

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_backend_metadata/ \
  Authorization:"Token YOUR_API_TOKEN" \
  backend_metadata=null

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_backend_metadata_request import ResourceBackendMetadataRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_backend_metadata # (2)

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

body_data = ResourceBackendMetadataRequest(
    backend_metadata=null
)
response = marketplace_provider_resources_set_backend_metadata.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)

1. Model Source: ResourceBackendMetadataRequest
2. API Source: marketplace_provider_resources_set_backend_metadata

import { marketplaceProviderResourcesSetBackendMetadata } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetBackendMetadata({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "backend_metadata": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
uuid	string (uuid)	✓

Field	Type	Required
backend_metadata	any	✓

200 -

Field	Type
status	string

---

Set downscaled flag for resource

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

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_downscaled_request import ResourceDownscaledRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_downscaled # (2)

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

body_data = ResourceDownscaledRequest()
response = marketplace_provider_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_provider_resources_set_downscaled

import { marketplaceProviderResourcesSetDownscaled } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetDownscaled({
  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 end date by provider

Allows a service provider to set or update the end date for a resource, scheduling it for termination. A notification is sent to the consumer.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_end_date_by_provider/ \
  Authorization:"Token YOUR_API_TOKEN"

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_provider_resources import marketplace_provider_resources_set_end_date_by_provider # (2)

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

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

print(response)

1. Model Source: ResourceEndDateByProviderRequest
2. API Source: marketplace_provider_resources_set_end_date_by_provider

import { marketplaceProviderResourcesSetEndDateByProvider } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetEndDateByProvider({
  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 end date of the resource by staff

Allows a staff user to set or update the end date for a resource, which will schedule it for termination.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

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

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_provider_resources import marketplace_provider_resources_set_end_date_by_staff # (2)

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

body_data = ResourceEndDateByProviderRequest()
response = marketplace_provider_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_provider_resources_set_end_date_by_staff

import { marketplaceProviderResourcesSetEndDateByStaff } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetEndDateByStaff({
  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 resource limits

Allows a service provider to directly set the limits for a resource. This is typically used for administrative changes or backend synchronization, bypassing the normal order process.

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_limits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  limits=null

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_set_limits_request import ResourceSetLimitsRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_limits # (2)

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

body_data = ResourceSetLimitsRequest(
    limits=null
)
response = marketplace_provider_resources_set_limits.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)

1. Model Source: ResourceSetLimitsRequest
2. API Source: marketplace_provider_resources_set_limits

import { marketplaceProviderResourcesSetLimits } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetLimits({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "limits": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
uuid	string (uuid)	✓

Field	Type	Required
limits	any	✓

200 -

Field	Type
status	string

---

Set paused flag for resource

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

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_paused_request import ResourcePausedRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_paused # (2)

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

body_data = ResourcePausedRequest()
response = marketplace_provider_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_provider_resources_set_paused

import { marketplaceProviderResourcesSetPaused } from 'waldur-js-client';

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

---

Set restrict member access flag

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

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

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

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_provider_resources import marketplace_provider_resources_set_restrict_member_access # (2)

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

body_data = ResourceRestrictMemberAccessRequest()
response = marketplace_provider_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_provider_resources_set_restrict_member_access

import { marketplaceProviderResourcesSetRestrictMemberAccess } from 'waldur-js-client';

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

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_slug_request import ResourceSlugRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_slug # (2)

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

body_data = ResourceSlugRequest(
    slug="string-value"
)
response = marketplace_provider_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_provider_resources_set_slug

import { marketplaceProviderResourcesSetSlug } from 'waldur-js-client';

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

---

Submit a report for a resource

Allows a service provider to submit a report (e.g., usage or status report) for a resource.

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/submit_report/ \
  Authorization:"Token YOUR_API_TOKEN" \
  report:='[]'

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_report_request import ResourceReportRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_submit_report # (2)

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

body_data = ResourceReportRequest(
    report=[]
)
response = marketplace_provider_resources_submit_report.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)

1. Model Source: ResourceReportRequest
2. API Source: marketplace_provider_resources_submit_report

import { marketplaceProviderResourcesSubmitReport } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSubmitReport({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "report": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
uuid	string (uuid)	✓

Field	Type	Required
report	array of objects	✓
report.header	string	✓
report.body	string	✓

200 -

Field	Type
status	string

---

Terminate a resource

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

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_terminate_request import ResourceTerminateRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_terminate # (2)

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

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

print(response)

1. Model Source: ResourceTerminateRequest
2. API Source: marketplace_provider_resources_terminate

import { marketplaceProviderResourcesTerminate } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesTerminate({
  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
attributes	any

200 -

Field	Type
order_uuid	string (uuid)

---