Search
K
Cipherscale API

Configure Resource Load Balancing

Configures load balancing settings for a resource, determining how traffic is distributed across multiple gateways. Supports both manual gateway selection and automatic load balancing algorithms.

post
https://public-api.cipherscale.com/qa/tenants/resources/{id}/loadBalancing

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the resource

Body

application/json

ApplyLoadBalancingDto

loadBalancingModestringrequired

Allowed values:MANUALAUTOMATIC

Default:MANUAL

gatewaysarray[string]required

Response

Successfully applied load balancing configuration

post/tenants/resources/{id}/loadBalancing

Body

{ "loadBalancingMode": "MANUAL", "gateways": [ "[]" ] }
 

Connect Resource to Gateways

Establishes network connections between a resource and one or more gateways, enabling users to access the resource through those gateways. This operation is essential for defining network topology and access paths.

post
https://public-api.cipherscale.com/qa/tenants/resources/{id}/gateways

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the resource

Body

application/json
gatewaysarray[string](uuid)required

Comma-separated list of gateway IDs

Response

application/json

Successfully created resource-gateway connections

addressIdstringrequired
gatewayIdstringrequired
post/tenants/resources/{id}/gateways

Body

{ "gateways": [ "[]" ] }
 
application/json

Disconnect Resource from Gateway

Removes the network connection between a resource and a specific gateway, preventing access to the resource through that gateway. This operation helps manage network topology and access control.

delete
https://public-api.cipherscale.com/qa/tenants/resources/{id}/gateways/{gatewayId}

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the resource

gatewayIdstring(uuid)required

The unique identifier (UUID) of the gateway to disconnect

Response

Successfully disconnected resource from gateway

delete/tenants/resources/{id}/gateways/{gatewayId}
 

Addresses

Network address and endpoint management

List All Network Addresses

Retrieves all network addresses configured for the tenant, including IP addresses, hostnames, and domain names with their associated protocols and access types.

get
https://public-api.cipherscale.com/qa/tenants/addresses

Response

application/json

Successfully retrieved addresses

idstring(uuid)required
addressstringrequired
isIpbooleanrequired
typestringrequired

Allowed values:PRIVATESAASINTERNET

protocolsarray[object]required
Show Child Parameters
get/tenants/addresses
 
application/json