Openstack

Operations Summary

Method	Endpoint	Description
GET	/api/openstack/discovery/	List Openstack Discovery
GET	/api/openstack/discovery/{id}/	Retrieve
GET	/api/openstack-health-monitors/	List health monitors
GET	/api/openstack-health-monitors/{uuid}/	Get health monitor details
GET	/api/openstack-listeners/	List listeners
GET	/api/openstack-listeners/{uuid}/	Get listener details
GET	/api/openstack-loadbalancers/	List load balancers
GET	/api/openstack-loadbalancers/{uuid}/	Get load balancer details
GET	/api/openstack-pool-members/	List pool members
GET	/api/openstack-pool-members/{uuid}/	Get pool member details
GET	/api/openstack-pools/	List pools
GET	/api/openstack-pools/{uuid}/	Get pool details
POST	/api/openstack/discovery/	Create
POST	/api/openstack/discovery/discover_external_networks/	Discover available external networks
POST	/api/openstack/discovery/discover_flavors/	Discover available flavors
POST	/api/openstack/discovery/discover_instance_availability_zones/	Discover available Nova instance availability zones
POST	/api/openstack/discovery/discover_volume_availability_zones/	Discover available Cinder volume availability zones
POST	/api/openstack/discovery/discover_volume_types/	Discover available volume types
POST	/api/openstack/discovery/preview_service_attributes/	Build service_attributes and plugin_options from selected values
POST	/api/openstack/discovery/validate_credentials/	Validate OpenStack credentials without saving them
POST	/api/openstack-health-monitors/	Create health monitor
POST	/api/openstack-listeners/	Create listener
POST	/api/openstack-loadbalancers/{uuid}/attach_floating_ip/	Attach floating IP to VIP
POST	/api/openstack-loadbalancers/	Create load balancer
POST	/api/openstack-loadbalancers/{uuid}/detach_floating_ip/	Detach floating IP from VIP
POST	/api/openstack-loadbalancers/{uuid}/update_vip_security_groups/	Update VIP security groups
POST	/api/openstack-pool-members/	Create pool member
POST	/api/openstack-pools/	Create pool
PUT	/api/openstack/discovery/{id}/	Update
PUT	/api/openstack-health-monitors/{uuid}/	Update health monitor
PUT	/api/openstack-listeners/{uuid}/	Update listener
PUT	/api/openstack-loadbalancers/{uuid}/	Update load balancer
PUT	/api/openstack-pool-members/{uuid}/	Update pool member
PUT	/api/openstack-pools/{uuid}/	Update pool
PATCH	/api/openstack/discovery/{id}/	Partial Update
PATCH	/api/openstack-health-monitors/{uuid}/	Partially update health monitor
PATCH	/api/openstack-listeners/{uuid}/	Partially update listener
PATCH	/api/openstack-loadbalancers/{uuid}/	Partially update load balancer
PATCH	/api/openstack-pool-members/{uuid}/	Partially update pool member
PATCH	/api/openstack-pools/{uuid}/	Partially update pool
DELETE	/api/openstack/discovery/{id}/	Delete
DELETE	/api/openstack-health-monitors/{uuid}/	Delete health monitor
DELETE	/api/openstack-listeners/{uuid}/	Delete listener
DELETE	/api/openstack-loadbalancers/{uuid}/	Delete load balancer
DELETE	/api/openstack-pool-members/{uuid}/	Delete pool member
DELETE	/api/openstack-pools/{uuid}/	Delete pool

---

List Openstack Discovery

HTTPiePythonTypeScriptQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/openstack/discovery/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack import openstack_discovery_list # (1)

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

print(response)

1. API Source: openstack_discovery_list

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

try {
  const response = await openstackDiscoveryList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.

200 - No response body

---

Retrieve

HTTPiePythonTypeScriptPath ParametersResponses

http \
  GET \
  https://api.example.com/api/openstack/discovery/123/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack import openstack_discovery_retrieve # (1)

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

print(response)

1. API Source: openstack_discovery_retrieve

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

try {
  const response = await openstackDiscoveryRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required	Description
id	integer	✓	A unique integer value identifying this Service provider.

200 - No response body

---

List health monitors

Get a list of pool health monitors.

HTTPiePythonTypeScriptQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/openstack-health-monitors/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_health_monitor_field_enum import OpenStackHealthMonitorFieldEnum # (2)
from waldur_api_client.api.openstack_health_monitors import openstack_health_monitors_list # (3)

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

for item in response:
    print(item)

1. Model Source: CoreStates
2. Model Source: OpenStackHealthMonitorFieldEnum
3. API Source: openstack_health_monitors_list

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

try {
  const response = await openstackHealthMonitorsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
field	array
load_balancer_uuid	string (uuid)	Load balancer UUID
name	string	Name
name_exact	string	Name (exact)
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.
pool	string (uri)	Pool URL
pool_uuid	string (uuid)	Pool UUID
state	array	State
tenant_uuid	string (uuid)	Tenant 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)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Health monitor ID in Octavia
access_url	string
pool	string (uri)	Pool this health monitor belongs to
pool_name	string
pool_uuid	string (uuid)
load_balancer_uuid	string (uuid)
type	string
delay	integer
timeout	integer
max_retries	integer
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

Get health monitor details

Retrieve details of a specific health monitor.

HTTPiePythonTypeScriptPath ParametersQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/openstack-health-monitors/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_health_monitor_field_enum import OpenStackHealthMonitorFieldEnum # (1)
from waldur_api_client.api.openstack_health_monitors import openstack_health_monitors_retrieve # (2)

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

print(response)

1. Model Source: OpenStackHealthMonitorFieldEnum
2. API Source: openstack_health_monitors_retrieve

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

try {
  const response = await openstackHealthMonitorsRetrieve({
  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
url	string (uri)
uuid	string (uuid)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Health monitor ID in Octavia
access_url	string
pool	string (uri)	Pool this health monitor belongs to
pool_name	string
pool_uuid	string (uuid)
load_balancer_uuid	string (uuid)
type	string
delay	integer
timeout	integer
max_retries	integer
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

List listeners

Get a list of load balancer listeners.

HTTPiePythonTypeScriptQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/openstack-listeners/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_listener_field_enum import OpenStackListenerFieldEnum # (2)
from waldur_api_client.api.openstack_listeners import openstack_listeners_list # (3)

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

for item in response:
    print(item)

1. Model Source: CoreStates
2. Model Source: OpenStackListenerFieldEnum
3. API Source: openstack_listeners_list

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

try {
  const response = await openstackListenersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
field	array
load_balancer	string (uri)	Load balancer URL
load_balancer_uuid	string (uuid)	Load balancer UUID
name	string	Name
name_exact	string	Name (exact)
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.
state	array	State
tenant_uuid	string (uuid)	Tenant 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)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Listener ID in Octavia
access_url	string
load_balancer	string (uri)	Load balancer this listener belongs to
load_balancer_name	string
load_balancer_uuid	string (uuid)
protocol	string
protocol_port	integer
default_pool	string (uri)	Default pool for this listener
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

Get listener details

Retrieve details of a specific listener.

HTTPiePythonTypeScriptPath ParametersQuery ParametersResponses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_listener_field_enum import OpenStackListenerFieldEnum # (1)
from waldur_api_client.api.openstack_listeners import openstack_listeners_retrieve # (2)

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

print(response)

1. Model Source: OpenStackListenerFieldEnum
2. API Source: openstack_listeners_retrieve

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

try {
  const response = await openstackListenersRetrieve({
  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
url	string (uri)
uuid	string (uuid)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Listener ID in Octavia
access_url	string
load_balancer	string (uri)	Load balancer this listener belongs to
load_balancer_name	string
load_balancer_uuid	string (uuid)
protocol	string
protocol_port	integer
default_pool	string (uri)	Default pool for this listener
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

List load balancers

Get a list of load balancers.

HTTPiePythonTypeScriptQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/openstack-loadbalancers/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_load_balancer_field_enum import OpenStackLoadBalancerFieldEnum # (2)
from waldur_api_client.api.openstack_loadbalancers import openstack_loadbalancers_list # (3)

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

for item in response:
    print(item)

1. Model Source: CoreStates
2. Model Source: OpenStackLoadBalancerFieldEnum
3. API Source: openstack_loadbalancers_list

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

try {
  const response = await openstackLoadbalancersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
field	array
name	string	Name
name_exact	string	Name (exact)
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.
state	array	State
tenant	string (uri)	Tenant URL
tenant_uuid	string (uuid)	Tenant 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)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Load balancer ID in Octavia
access_url	string
tenant	string (uri)	OpenStack tenant this load balancer belongs to
tenant_name	string
tenant_uuid	string (uuid)
vip_address	any	An IPv4 or IPv6 address.
vip_subnet_id	string
vip_port_id	string
attached_floating_ip	string (uri)	Floating IP attached to the VIP port
provider	string
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

Get load balancer details

Retrieve details of a specific load balancer.

HTTPiePythonTypeScriptPath ParametersQuery ParametersResponses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_load_balancer_field_enum import OpenStackLoadBalancerFieldEnum # (1)
from waldur_api_client.api.openstack_loadbalancers import openstack_loadbalancers_retrieve # (2)

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

print(response)

1. Model Source: OpenStackLoadBalancerFieldEnum
2. API Source: openstack_loadbalancers_retrieve

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

try {
  const response = await openstackLoadbalancersRetrieve({
  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
url	string (uri)
uuid	string (uuid)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Load balancer ID in Octavia
access_url	string
tenant	string (uri)	OpenStack tenant this load balancer belongs to
tenant_name	string
tenant_uuid	string (uuid)
vip_address	any	An IPv4 or IPv6 address.
vip_subnet_id	string
vip_port_id	string
attached_floating_ip	string (uri)	Floating IP attached to the VIP port
provider	string
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

List pool members

Get a list of pool members.

HTTPiePythonTypeScriptQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/openstack-pool-members/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_pool_member_field_enum import OpenStackPoolMemberFieldEnum # (2)
from waldur_api_client.api.openstack_pool_members import openstack_pool_members_list # (3)

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

for item in response:
    print(item)

1. Model Source: CoreStates
2. Model Source: OpenStackPoolMemberFieldEnum
3. API Source: openstack_pool_members_list

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

try {
  const response = await openstackPoolMembersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
field	array
load_balancer_uuid	string (uuid)	Load balancer UUID
name	string	Name
name_exact	string	Name (exact)
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.
pool	string (uri)	Pool URL
pool_uuid	string (uuid)	Pool UUID
state	array	State
tenant_uuid	string (uuid)	Tenant 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)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Member ID in Octavia
access_url	string
pool	string (uri)	Pool this member belongs to
pool_name	string
pool_uuid	string (uuid)
load_balancer_uuid	string (uuid)
address	any	An IPv4 or IPv6 address.
protocol_port	integer
subnet_id	string	Subnet ID for the member (required for creation)
weight	integer
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

Get pool member details

Retrieve details of a specific pool member.

HTTPiePythonTypeScriptPath ParametersQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/openstack-pool-members/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_pool_member_field_enum import OpenStackPoolMemberFieldEnum # (1)
from waldur_api_client.api.openstack_pool_members import openstack_pool_members_retrieve # (2)

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

print(response)

1. Model Source: OpenStackPoolMemberFieldEnum
2. API Source: openstack_pool_members_retrieve

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

try {
  const response = await openstackPoolMembersRetrieve({
  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
url	string (uri)
uuid	string (uuid)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Member ID in Octavia
access_url	string
pool	string (uri)	Pool this member belongs to
pool_name	string
pool_uuid	string (uuid)
load_balancer_uuid	string (uuid)
address	any	An IPv4 or IPv6 address.
protocol_port	integer
subnet_id	string	Subnet ID for the member (required for creation)
weight	integer
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

List pools

Get a list of load balancer pools.

HTTPiePythonTypeScriptQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/openstack-pools/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_pool_field_enum import OpenStackPoolFieldEnum # (2)
from waldur_api_client.api.openstack_pools import openstack_pools_list # (3)

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

for item in response:
    print(item)

1. Model Source: CoreStates
2. Model Source: OpenStackPoolFieldEnum
3. API Source: openstack_pools_list

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

try {
  const response = await openstackPoolsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
field	array
load_balancer	string (uri)	Load balancer URL
load_balancer_uuid	string (uuid)	Load balancer UUID
name	string	Name
name_exact	string	Name (exact)
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.
state	array	State
tenant_uuid	string (uuid)	Tenant 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)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Pool ID in Octavia
access_url	string
load_balancer	string (uri)	Load balancer this pool belongs to
load_balancer_name	string
load_balancer_uuid	string (uuid)
protocol	string
lb_algorithm	string
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

Get pool details

Retrieve details of a specific pool.

HTTPiePythonTypeScriptPath ParametersQuery ParametersResponses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_pool_field_enum import OpenStackPoolFieldEnum # (1)
from waldur_api_client.api.openstack_pools import openstack_pools_retrieve # (2)

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

print(response)

1. Model Source: OpenStackPoolFieldEnum
2. API Source: openstack_pools_retrieve

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

try {
  const response = await openstackPoolsRetrieve({
  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
url	string (uri)
uuid	string (uuid)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Pool ID in Octavia
access_url	string
load_balancer	string (uri)	Load balancer this pool belongs to
load_balancer_name	string
load_balancer_uuid	string (uuid)
protocol	string
lb_algorithm	string
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

Create

HTTPiePythonTypeScriptResponses

http \
  POST \
  https://api.example.com/api/openstack/discovery/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack import openstack_discovery_create # (1)

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

print(response)

1. API Source: openstack_discovery_create

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

try {
  const response = await openstackDiscoveryCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

201 - No response body

---

Discover available external networks

Discover available external networks.

HTTPiePythonTypeScriptQuery ParametersRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack/discovery/discover_external_networks/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_external_networks_request_request import DiscoverExternalNetworksRequestRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_discover_external_networks # (2)

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

body_data = DiscoverExternalNetworksRequestRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_discover_external_networks.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)

1. Model Source: DiscoverExternalNetworksRequestRequest
2. API Source: openstack_discovery_discover_external_networks

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

try {
  const response = await openstackDiscoveryDiscoverExternalNetworks({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.

Field	Type	Required	Description
auth_url	string (uri)	✓	Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username	string	✓
password	string	✓	Constraints: write-only
user_domain_name	string		Keystone user domain name Constraints: default: Default
project_domain_name	string		Keystone project domain name Constraints: default: Default
project_name	string		Keystone project (tenant) name Constraints: default: admin
auth_type	any		Authentication method: password or v3applicationcredential Constraints: default: password
verify_ssl	boolean		Constraints: default: False
certificate	string		PEM-encoded CA certificate for SSL verification Constraints: write-only

200 -

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

Field	Type
id	string
name	string
is_shared	boolean
subnets	array of objects
subnets.id	string
subnets.name	string
subnets.cidr	string
subnets.gateway_ip	string
subnets.ip_version	integer

---

Discover available flavors

Discover available flavors.

HTTPiePythonTypeScriptQuery ParametersRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack/discovery/discover_flavors/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_flavors_request_request import DiscoverFlavorsRequestRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_discover_flavors # (2)

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

body_data = DiscoverFlavorsRequestRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_discover_flavors.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)

1. Model Source: DiscoverFlavorsRequestRequest
2. API Source: openstack_discovery_discover_flavors

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

try {
  const response = await openstackDiscoveryDiscoverFlavors({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.

Field	Type	Required	Description
auth_url	string (uri)	✓	Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username	string	✓
password	string	✓	Constraints: write-only
user_domain_name	string		Keystone user domain name Constraints: default: Default
project_domain_name	string		Keystone project domain name Constraints: default: Default
project_name	string		Keystone project (tenant) name Constraints: default: admin
auth_type	any		Authentication method: password or v3applicationcredential Constraints: default: password
verify_ssl	boolean		Constraints: default: False
certificate	string		PEM-encoded CA certificate for SSL verification Constraints: write-only

200 -

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

Field	Type	Description
id	string
name	string
vcpus	integer
ram	integer	RAM in MB
disk	integer	Disk in GB

---

Discover available Nova instance availability zones

Discover available Nova instance availability zones.

HTTPiePythonTypeScriptQuery ParametersRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack/discovery/discover_instance_availability_zones/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_instance_availability_zones_request_request import DiscoverInstanceAvailabilityZonesRequestRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_discover_instance_availability_zones # (2)

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

body_data = DiscoverInstanceAvailabilityZonesRequestRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_discover_instance_availability_zones.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)

1. Model Source: DiscoverInstanceAvailabilityZonesRequestRequest
2. API Source: openstack_discovery_discover_instance_availability_zones

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

try {
  const response = await openstackDiscoveryDiscoverInstanceAvailabilityZones({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.

Field	Type	Required	Description
auth_url	string (uri)	✓	Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username	string	✓
password	string	✓	Constraints: write-only
user_domain_name	string		Keystone user domain name Constraints: default: Default
project_domain_name	string		Keystone project domain name Constraints: default: Default
project_name	string		Keystone project (tenant) name Constraints: default: admin
auth_type	any		Authentication method: password or v3applicationcredential Constraints: default: password
verify_ssl	boolean		Constraints: default: False
certificate	string		PEM-encoded CA certificate for SSL verification Constraints: write-only

200 -

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

Field	Type
name	string
state	string

---

Discover available Cinder volume availability zones

Discover available Cinder volume availability zones.

HTTPiePythonTypeScriptQuery ParametersRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack/discovery/discover_volume_availability_zones/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_volume_availability_zones_request_request import DiscoverVolumeAvailabilityZonesRequestRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_discover_volume_availability_zones # (2)

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

body_data = DiscoverVolumeAvailabilityZonesRequestRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_discover_volume_availability_zones.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)

1. Model Source: DiscoverVolumeAvailabilityZonesRequestRequest
2. API Source: openstack_discovery_discover_volume_availability_zones

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

try {
  const response = await openstackDiscoveryDiscoverVolumeAvailabilityZones({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.

Field	Type	Required	Description
auth_url	string (uri)	✓	Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username	string	✓
password	string	✓	Constraints: write-only
user_domain_name	string		Keystone user domain name Constraints: default: Default
project_domain_name	string		Keystone project domain name Constraints: default: Default
project_name	string		Keystone project (tenant) name Constraints: default: admin
auth_type	any		Authentication method: password or v3applicationcredential Constraints: default: password
verify_ssl	boolean		Constraints: default: False
certificate	string		PEM-encoded CA certificate for SSL verification Constraints: write-only

200 -

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

Field	Type
name	string
state	string

---

Discover available volume types

Discover available volume types.

HTTPiePythonTypeScriptQuery ParametersRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack/discovery/discover_volume_types/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_volume_types_request_request import DiscoverVolumeTypesRequestRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_discover_volume_types # (2)

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

body_data = DiscoverVolumeTypesRequestRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_discover_volume_types.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)

1. Model Source: DiscoverVolumeTypesRequestRequest
2. API Source: openstack_discovery_discover_volume_types

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

try {
  const response = await openstackDiscoveryDiscoverVolumeTypes({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.

Field	Type	Required	Description
auth_url	string (uri)	✓	Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username	string	✓
password	string	✓	Constraints: write-only
user_domain_name	string		Keystone user domain name Constraints: default: Default
project_domain_name	string		Keystone project domain name Constraints: default: Default
project_name	string		Keystone project (tenant) name Constraints: default: admin
auth_type	any		Authentication method: password or v3applicationcredential Constraints: default: password
verify_ssl	boolean		Constraints: default: False
certificate	string		PEM-encoded CA certificate for SSL verification Constraints: write-only

200 -

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

Field	Type
id	string
name	string
description	string

---

Build service_attributes and plugin_options from selected values

Build service_attributes and plugin_options from selected values.

HTTPiePythonTypeScriptRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack/discovery/preview_service_attributes/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.preview_service_attributes_request_request import PreviewServiceAttributesRequestRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_preview_service_attributes # (2)

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

body_data = PreviewServiceAttributesRequestRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_preview_service_attributes.sync(
    client=client,
    body=body_data
)

print(response)

1. Model Source: PreviewServiceAttributesRequestRequest
2. API Source: openstack_discovery_preview_service_attributes

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

try {
  const response = await openstackDiscoveryPreviewServiceAttributes({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Field	Type	Required	Description
auth_url	string (uri)	✓	Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username	string	✓
password	string	✓	Constraints: write-only
user_domain_name	string		Keystone user domain name Constraints: default: Default
project_domain_name	string		Keystone project domain name Constraints: default: Default
project_name	string		Keystone project (tenant) name Constraints: default: admin
auth_type	any		Authentication method: password or v3applicationcredential Constraints: default: password
verify_ssl	boolean		Constraints: default: False
certificate	string		PEM-encoded CA certificate for SSL verification Constraints: write-only
external_network_id	string		Selected external network ID Constraints: default: ``
instance_availability_zone	string		Selected instance availability zone name Constraints: default: ``
volume_availability_zone	string		Selected volume availability zone name Constraints: default: ``

200 -

Field	Type
service_attributes	object (free-form)
plugin_options	object (free-form)

---

Validate OpenStack credentials without saving them

Validate OpenStack credentials without saving them.

HTTPiePythonTypeScriptRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack/discovery/validate_credentials/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_credentials_request import OpenStackCredentialsRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_validate_credentials # (2)

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

body_data = OpenStackCredentialsRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_validate_credentials.sync(
    client=client,
    body=body_data
)

print(response)

1. Model Source: OpenStackCredentialsRequest
2. API Source: openstack_discovery_validate_credentials

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

try {
  const response = await openstackDiscoveryValidateCredentials({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Field	Type	Required	Description
auth_url	string (uri)	✓	Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username	string	✓
password	string	✓	Constraints: write-only
user_domain_name	string		Keystone user domain name Constraints: default: Default
project_domain_name	string		Keystone project domain name Constraints: default: Default
project_name	string		Keystone project (tenant) name Constraints: default: admin
auth_type	any		Authentication method: password or v3applicationcredential Constraints: default: password
verify_ssl	boolean		Constraints: default: False
certificate	string		PEM-encoded CA certificate for SSL verification Constraints: write-only

200 -

Field	Type
valid	boolean
message	string
error	string
server_info	any

---

Create health monitor

Create a new health monitor for a pool.

HTTPiePythonTypeScriptRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack-health-monitors/ \
  Authorization:"Token YOUR_API_TOKEN" \
  pool="https://api.example.com/api/pool/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  type="TCP" \
  delay=123 \
  timeout=123 \
  max_retries=123

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_health_monitor_request import CreateHealthMonitorRequest # (1)
from waldur_api_client.api.openstack_health_monitors import openstack_health_monitors_create # (2)

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

body_data = CreateHealthMonitorRequest(
    pool="https://api.example.com/api/pool/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    type="TCP",
    delay=123,
    timeout=123,
    max_retries=123
)
response = openstack_health_monitors_create.sync(
    client=client,
    body=body_data
)

print(response)

1. Model Source: CreateHealthMonitorRequest
2. API Source: openstack_health_monitors_create

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

try {
  const response = await openstackHealthMonitorsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "pool": "https://api.example.com/api/pool/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "type": "TCP",
    "delay": 123,
    "timeout": 123,
    "max_retries": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Field	Type	Required	Description
pool	string (uri)	✓	Pool this health monitor belongs to
name	string
type	string	✓	Enum: TCP, UDP
delay	integer	✓	Interval between health checks in seconds
timeout	integer	✓	Time in seconds to timeout a health check
max_retries	integer	✓	Number of retries before marking member as down

201 -

Field	Type	Description
url	string (uri)
uuid	string (uuid)
pool	string (uri)	Pool this health monitor belongs to
name	string
type	string	Enum: TCP, UDP
delay	integer	Interval between health checks in seconds
timeout	integer	Time in seconds to timeout a health check
max_retries	integer	Number of retries before marking member as down
project	string (uri)
service_settings	string (uri)

---

Create listener

Create a new listener for a load balancer.

HTTPiePythonTypeScriptRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack-listeners/ \
  Authorization:"Token YOUR_API_TOKEN" \
  load_balancer="https://api.example.com/api/load-balancer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  name="my-awesome-openstack-listener" \
  protocol="TCP" \
  protocol_port=8080

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_listener_request import CreateListenerRequest # (1)
from waldur_api_client.api.openstack_listeners import openstack_listeners_create # (2)

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

body_data = CreateListenerRequest(
    load_balancer="https://api.example.com/api/load-balancer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    name="my-awesome-openstack-listener",
    protocol="TCP",
    protocol_port=8080
)
response = openstack_listeners_create.sync(
    client=client,
    body=body_data
)

print(response)

1. Model Source: CreateListenerRequest
2. API Source: openstack_listeners_create

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

try {
  const response = await openstackListenersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "load_balancer": "https://api.example.com/api/load-balancer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "name": "my-awesome-openstack-listener",
    "protocol": "TCP",
    "protocol_port": 8080
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Field	Type	Required	Description
load_balancer	string (uri)	✓	Load balancer this listener belongs to
name	string	✓
protocol	string	✓	Enum: TCP, UDP
protocol_port	integer	✓	Port on which the listener listens
default_pool	string (uri)

201 -

Field	Type	Description
url	string (uri)
uuid	string (uuid)
load_balancer	string (uri)	Load balancer this listener belongs to
name	string
protocol	string	Enum: TCP, UDP
protocol_port	integer	Port on which the listener listens
default_pool	string (uri)
project	string (uri)
service_settings	string (uri)

---

Attach floating IP to VIP

Attach a floating IP to the load balancer VIP port.

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack-loadbalancers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/attach_floating_ip/ \
  Authorization:"Token YOUR_API_TOKEN" \
  floating_ip="8.8.8.8"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.load_balancer_attach_floating_ip_request import LoadBalancerAttachFloatingIPRequest # (1)
from waldur_api_client.api.openstack_loadbalancers import openstack_loadbalancers_attach_floating_ip # (2)

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

body_data = LoadBalancerAttachFloatingIPRequest(
    floating_ip="8.8.8.8"
)
response = openstack_loadbalancers_attach_floating_ip.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)

1. Model Source: LoadBalancerAttachFloatingIPRequest
2. API Source: openstack_loadbalancers_attach_floating_ip

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

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

Name	Type	Required
uuid	string (uuid)	✓

Field	Type	Required
floating_ip	string (uri)	✓

200 - No response body

---

Create load balancer

Create a new load balancer.

HTTPiePythonTypeScriptRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack-loadbalancers/ \
  Authorization:"Token YOUR_API_TOKEN" \
  tenant="https://api.example.com/api/tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  name="my-awesome-openstack-loadbalancer" \
  vip_subnet_id="string-value"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_load_balancer_request import CreateLoadBalancerRequest # (1)
from waldur_api_client.api.openstack_loadbalancers import openstack_loadbalancers_create # (2)

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

body_data = CreateLoadBalancerRequest(
    tenant="https://api.example.com/api/tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    name="my-awesome-openstack-loadbalancer",
    vip_subnet_id="string-value"
)
response = openstack_loadbalancers_create.sync(
    client=client,
    body=body_data
)

print(response)

1. Model Source: CreateLoadBalancerRequest
2. API Source: openstack_loadbalancers_create

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

try {
  const response = await openstackLoadbalancersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "tenant": "https://api.example.com/api/tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "name": "my-awesome-openstack-loadbalancer",
    "vip_subnet_id": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Field	Type	Required	Description
tenant	string (uri)	✓	OpenStack tenant this load balancer belongs to
name	string	✓
vip_subnet_id	string	✓

201 -

Field	Type	Description
url	string (uri)
uuid	string (uuid)
tenant	string (uri)	OpenStack tenant this load balancer belongs to
name	string
vip_subnet_id	string
project	string (uri)
service_settings	string (uri)

---

Detach floating IP from VIP

Detach floating IP from the load balancer VIP port.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  POST \
  https://api.example.com/api/openstack-loadbalancers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/detach_floating_ip/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_loadbalancers import openstack_loadbalancers_detach_floating_ip # (1)

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

print(response)

1. API Source: openstack_loadbalancers_detach_floating_ip

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

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

---

Update VIP security groups

Update security groups on the load balancer VIP port.

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack-loadbalancers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_vip_security_groups/ \
  Authorization:"Token YOUR_API_TOKEN" \
  security_groups:='["web-server-sg"]'

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.load_balancer_update_vip_security_groups_request import LoadBalancerUpdateVIPSecurityGroupsRequest # (1)
from waldur_api_client.api.openstack_loadbalancers import openstack_loadbalancers_update_vip_security_groups # (2)

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

body_data = LoadBalancerUpdateVIPSecurityGroupsRequest(
    security_groups=[
            "web-server-sg"
        ]
)
response = openstack_loadbalancers_update_vip_security_groups.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)

1. Model Source: LoadBalancerUpdateVIPSecurityGroupsRequest
2. API Source: openstack_loadbalancers_update_vip_security_groups

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

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

Name	Type	Required
uuid	string (uuid)	✓

Field	Type	Required
security_groups	array of string (uri)s	✓

200 - No response body

---

Create pool member

Create a new member for a pool.

HTTPiePythonTypeScriptRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack-pool-members/ \
  Authorization:"Token YOUR_API_TOKEN" \
  pool="https://api.example.com/api/pool/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  address=null \
  protocol_port=8080 \
  subnet_id="string-value"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_pool_member_request import CreatePoolMemberRequest # (1)
from waldur_api_client.api.openstack_pool_members import openstack_pool_members_create # (2)

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

body_data = CreatePoolMemberRequest(
    pool="https://api.example.com/api/pool/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    address=null,
    protocol_port=8080,
    subnet_id="string-value"
)
response = openstack_pool_members_create.sync(
    client=client,
    body=body_data
)

print(response)

1. Model Source: CreatePoolMemberRequest
2. API Source: openstack_pool_members_create

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

try {
  const response = await openstackPoolMembersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "pool": "https://api.example.com/api/pool/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "address": null,
    "protocol_port": 8080,
    "subnet_id": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Field	Type	Required	Description
pool	string (uri)	✓	Pool this member belongs to
name	string
address	any	✓	An IPv4 or IPv6 address.
protocol_port	integer	✓	Port on the backend server
subnet_id	string	✓
weight	integer		Constraints: default: 1

201 -

Field	Type	Description
url	string (uri)
uuid	string (uuid)
pool	string (uri)	Pool this member belongs to
name	string
address	any	An IPv4 or IPv6 address.
protocol_port	integer	Port on the backend server
subnet_id	string
weight	integer
project	string (uri)
service_settings	string (uri)

---

Create pool

Create a new pool for a load balancer.

HTTPiePythonTypeScriptRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/openstack-pools/ \
  Authorization:"Token YOUR_API_TOKEN" \
  load_balancer="https://api.example.com/api/load-balancer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  name="my-awesome-openstack-pool" \
  protocol="TCP"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_pool_request import CreatePoolRequest # (1)
from waldur_api_client.api.openstack_pools import openstack_pools_create # (2)

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

body_data = CreatePoolRequest(
    load_balancer="https://api.example.com/api/load-balancer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    name="my-awesome-openstack-pool",
    protocol="TCP"
)
response = openstack_pools_create.sync(
    client=client,
    body=body_data
)

print(response)

1. Model Source: CreatePoolRequest
2. API Source: openstack_pools_create

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

try {
  const response = await openstackPoolsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "load_balancer": "https://api.example.com/api/load-balancer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "name": "my-awesome-openstack-pool",
    "protocol": "TCP"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Field	Type	Required	Description
load_balancer	string (uri)	✓	Load balancer this pool belongs to
name	string	✓
protocol	string	✓	Enum: TCP, UDP
lb_algorithm	any		Constraints: default: SOURCE_IP_PORT

201 -

Field	Type	Description
url	string (uri)
uuid	string (uuid)
load_balancer	string (uri)	Load balancer this pool belongs to
name	string
protocol	string	Enum: TCP, UDP
lb_algorithm	any
project	string (uri)
service_settings	string (uri)

---

Update

HTTPiePythonTypeScriptPath ParametersResponses

http \
  PUT \
  https://api.example.com/api/openstack/discovery/123/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack import openstack_discovery_update # (1)

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

print(response)

1. API Source: openstack_discovery_update

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

try {
  const response = await openstackDiscoveryUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required	Description
id	integer	✓	A unique integer value identifying this Service provider.

200 - No response body

---

Update health monitor

Update an existing health monitor.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

http \
  PUT \
  https://api.example.com/api/openstack-health-monitors/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.update_health_monitor_request import UpdateHealthMonitorRequest # (1)
from waldur_api_client.api.openstack_health_monitors import openstack_health_monitors_update # (2)

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

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

print(response)

1. Model Source: UpdateHealthMonitorRequest
2. API Source: openstack_health_monitors_update

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

try {
  const response = await openstackHealthMonitorsUpdate({
  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
name	string
delay	integer
timeout	integer
max_retries	integer

200 -

Field	Type
name	string
delay	integer
timeout	integer
max_retries	integer

---

Update listener

Update an existing listener.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

http \
  PUT \
  https://api.example.com/api/openstack-listeners/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.update_listener_request import UpdateListenerRequest # (1)
from waldur_api_client.api.openstack_listeners import openstack_listeners_update # (2)

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

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

print(response)

1. Model Source: UpdateListenerRequest
2. API Source: openstack_listeners_update

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

try {
  const response = await openstackListenersUpdate({
  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
name	string
default_pool	string (uri)

200 -

Field	Type
name	string
default_pool	string (uri)

---

Update load balancer

Update an existing load balancer.

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

http \
  PUT \
  https://api.example.com/api/openstack-loadbalancers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-loadbalancer" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  tenant="https://api.example.com/api/tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_load_balancer_request import OpenStackLoadBalancerRequest # (1)
from waldur_api_client.api.openstack_loadbalancers import openstack_loadbalancers_update # (2)

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

body_data = OpenStackLoadBalancerRequest(
    name="my-awesome-openstack-loadbalancer",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    tenant="https://api.example.com/api/tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openstack_loadbalancers_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)

1. Model Source: OpenStackLoadBalancerRequest
2. API Source: openstack_loadbalancers_update

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

try {
  const response = await openstackLoadbalancersUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-loadbalancer",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "tenant": "https://api.example.com/api/tenant/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
service_settings	string (uri)	✓
project	string (uri)	✓
error_message	string
error_traceback	string
backend_id	string		Load balancer ID in Octavia
tenant	string (uri)	✓	OpenStack tenant this load balancer belongs to
attached_floating_ip	string (uri)		Floating IP attached to the VIP port

200 -

Field	Type	Description
url	string (uri)
uuid	string (uuid)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Load balancer ID in Octavia
access_url	string
tenant	string (uri)	OpenStack tenant this load balancer belongs to
tenant_name	string
tenant_uuid	string (uuid)
vip_address	any	An IPv4 or IPv6 address.
vip_subnet_id	string
vip_port_id	string
attached_floating_ip	string (uri)	Floating IP attached to the VIP port
provider	string
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

Update pool member

Update an existing pool member.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

http \
  PUT \
  https://api.example.com/api/openstack-pool-members/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.update_pool_member_request import UpdatePoolMemberRequest # (1)
from waldur_api_client.api.openstack_pool_members import openstack_pool_members_update # (2)

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

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

print(response)

1. Model Source: UpdatePoolMemberRequest
2. API Source: openstack_pool_members_update

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

try {
  const response = await openstackPoolMembersUpdate({
  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
name	string
weight	integer

200 -

Field	Type
name	string
weight	integer

---

Update pool

Update an existing pool.

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

http \
  PUT \
  https://api.example.com/api/openstack-pools/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-pool" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  load_balancer="https://api.example.com/api/load-balancer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_pool_request import OpenStackPoolRequest # (1)
from waldur_api_client.api.openstack_pools import openstack_pools_update # (2)

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

body_data = OpenStackPoolRequest(
    name="my-awesome-openstack-pool",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    load_balancer="https://api.example.com/api/load-balancer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openstack_pools_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)

1. Model Source: OpenStackPoolRequest
2. API Source: openstack_pools_update

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

try {
  const response = await openstackPoolsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-pool",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "load_balancer": "https://api.example.com/api/load-balancer/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
service_settings	string (uri)	✓
project	string (uri)	✓
error_message	string
error_traceback	string
backend_id	string		Pool ID in Octavia
load_balancer	string (uri)	✓	Load balancer this pool belongs to

200 -

Field	Type	Description
url	string (uri)
uuid	string (uuid)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Pool ID in Octavia
access_url	string
load_balancer	string (uri)	Load balancer this pool belongs to
load_balancer_name	string
load_balancer_uuid	string (uuid)
protocol	string
lb_algorithm	string
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

Partial Update

HTTPiePythonTypeScriptPath ParametersResponses

http \
  PATCH \
  https://api.example.com/api/openstack/discovery/123/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack import openstack_discovery_partial_update # (1)

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

print(response)

1. API Source: openstack_discovery_partial_update

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

try {
  const response = await openstackDiscoveryPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required	Description
id	integer	✓	A unique integer value identifying this Service provider.

200 - No response body

---

Partially update health monitor

Update specific fields of a health monitor.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

http \
  PATCH \
  https://api.example.com/api/openstack-health-monitors/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_update_health_monitor_request import PatchedUpdateHealthMonitorRequest # (1)
from waldur_api_client.api.openstack_health_monitors import openstack_health_monitors_partial_update # (2)

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

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

print(response)

1. Model Source: PatchedUpdateHealthMonitorRequest
2. API Source: openstack_health_monitors_partial_update

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

try {
  const response = await openstackHealthMonitorsPartialUpdate({
  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
name	string
delay	integer
timeout	integer
max_retries	integer

200 -

Field	Type
name	string
delay	integer
timeout	integer
max_retries	integer

---

Partially update listener

Update specific fields of a listener.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_update_listener_request import PatchedUpdateListenerRequest # (1)
from waldur_api_client.api.openstack_listeners import openstack_listeners_partial_update # (2)

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

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

print(response)

1. Model Source: PatchedUpdateListenerRequest
2. API Source: openstack_listeners_partial_update

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

try {
  const response = await openstackListenersPartialUpdate({
  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
name	string
default_pool	string (uri)

200 -

Field	Type
name	string
default_pool	string (uri)

---

Partially update load balancer

Update specific fields of a load balancer.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_load_balancer_request import PatchedOpenStackLoadBalancerRequest # (1)
from waldur_api_client.api.openstack_loadbalancers import openstack_loadbalancers_partial_update # (2)

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

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

print(response)

1. Model Source: PatchedOpenStackLoadBalancerRequest
2. API Source: openstack_loadbalancers_partial_update

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

try {
  const response = await openstackLoadbalancersPartialUpdate({
  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
service_settings	string (uri)
project	string (uri)
error_message	string
error_traceback	string
backend_id	string		Load balancer ID in Octavia
tenant	string (uri)		OpenStack tenant this load balancer belongs to
attached_floating_ip	string (uri)		Floating IP attached to the VIP port

200 -

Field	Type	Description
url	string (uri)
uuid	string (uuid)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Load balancer ID in Octavia
access_url	string
tenant	string (uri)	OpenStack tenant this load balancer belongs to
tenant_name	string
tenant_uuid	string (uuid)
vip_address	any	An IPv4 or IPv6 address.
vip_subnet_id	string
vip_port_id	string
attached_floating_ip	string (uri)	Floating IP attached to the VIP port
provider	string
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

Partially update pool member

Update specific fields of a pool member.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

http \
  PATCH \
  https://api.example.com/api/openstack-pool-members/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_update_pool_member_request import PatchedUpdatePoolMemberRequest # (1)
from waldur_api_client.api.openstack_pool_members import openstack_pool_members_partial_update # (2)

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

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

print(response)

1. Model Source: PatchedUpdatePoolMemberRequest
2. API Source: openstack_pool_members_partial_update

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

try {
  const response = await openstackPoolMembersPartialUpdate({
  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
name	string
weight	integer

200 -

Field	Type
name	string
weight	integer

---

Partially update pool

Update specific fields of a pool.

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

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

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_pool_request import PatchedOpenStackPoolRequest # (1)
from waldur_api_client.api.openstack_pools import openstack_pools_partial_update # (2)

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

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

print(response)

1. Model Source: PatchedOpenStackPoolRequest
2. API Source: openstack_pools_partial_update

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

try {
  const response = await openstackPoolsPartialUpdate({
  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
service_settings	string (uri)
project	string (uri)
error_message	string
error_traceback	string
backend_id	string		Pool ID in Octavia
load_balancer	string (uri)		Load balancer this pool belongs to

200 -

Field	Type	Description
url	string (uri)
uuid	string (uuid)
name	string
description	string
service_name	string
service_settings	string (uri)
service_settings_uuid	string (uuid)
service_settings_state	string
service_settings_error_message	string
project	string (uri)
project_name	string
project_uuid	string (uuid)
customer	string (uri)
customer_uuid	string (uuid)
customer_name	string
customer_native_name	string
customer_abbreviation	string
error_message	string
error_traceback	string
resource_type	string
state	any
created	string (date-time)
modified	string (date-time)
backend_id	string	Pool ID in Octavia
access_url	string
load_balancer	string (uri)	Load balancer this pool belongs to
load_balancer_name	string
load_balancer_uuid	string (uuid)
protocol	string
lb_algorithm	string
provisioning_status	string
operating_status	string
marketplace_offering_uuid	string
marketplace_offering_name	string
marketplace_offering_type	string
marketplace_offering_plugin_options	object (free-form)
marketplace_category_uuid	string
marketplace_category_name	string
marketplace_resource_uuid	string
marketplace_plan_uuid	string
marketplace_resource_state	string
is_usage_based	boolean
is_limit_based	boolean

---

Delete

HTTPiePythonTypeScriptPath ParametersResponses

http \
  DELETE \
  https://api.example.com/api/openstack/discovery/123/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack import openstack_discovery_destroy # (1)

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

print(response)

1. API Source: openstack_discovery_destroy

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

try {
  const response = await openstackDiscoveryDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required	Description
id	integer	✓	A unique integer value identifying this Service provider.

204 - No response body

---

Delete health monitor

Delete a health monitor.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  DELETE \
  https://api.example.com/api/openstack-health-monitors/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_health_monitors import openstack_health_monitors_destroy # (1)

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

print(response)

1. API Source: openstack_health_monitors_destroy

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

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

---

Delete listener

Delete a listener.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  DELETE \
  https://api.example.com/api/openstack-listeners/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_listeners import openstack_listeners_destroy # (1)

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

print(response)

1. API Source: openstack_listeners_destroy

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

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

---

Delete load balancer

Delete a load balancer.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  DELETE \
  https://api.example.com/api/openstack-loadbalancers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_loadbalancers import openstack_loadbalancers_destroy # (1)

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

print(response)

1. API Source: openstack_loadbalancers_destroy

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

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

---

Delete pool member

Delete a pool member.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  DELETE \
  https://api.example.com/api/openstack-pool-members/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_pool_members import openstack_pool_members_destroy # (1)

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

print(response)

1. API Source: openstack_pool_members_destroy

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

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

---

Delete pool

Delete a pool.

HTTPiePythonTypeScriptPath ParametersResponses

http \
  DELETE \
  https://api.example.com/api/openstack-pools/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_pools import openstack_pools_destroy # (1)

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

print(response)

1. API Source: openstack_pools_destroy

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

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

---