Search
K
Cipherscale API

Remove Network Resource

Permanently removes a network resource from the tenant. The resource must not be linked to any active policies before deletion. This operation will also disconnect all associated gateway connections.

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

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the resource to delete

Response

Successfully deleted the resource

delete/tenants/resources/{id}
  
curl --request DELETE \
  --url https://public-api.cipherscale.com/qa/tenants/resources/ \
  --header 'Content-Type: application/json' \
  --header 'apikey: '
Successfully deleted the resource

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

ApplyLoadBalancing

Configuration for applying load balancing to resources

loadBalancingModestringrequired

Load balancing mode for the resource

Allowed values:MANUALAUTOMATIC

Default:MANUAL

Example:AUTOMATIC

gatewaysarray[string]required

Array of gateway IDs to use for load balancing

Example:["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]

Response

Successfully applied load balancing configuration

post/tenants/resources/{id}/loadBalancing

Body

{
  "loadBalancingMode": "AUTOMATIC",
  "gateways": [
    "550e8400-e29b-41d4-a716-446655440000",
    "550e8400-e29b-41d4-a716-446655440001"
  ]
}
{ "loadBalancingMode": "AUTOMATIC", "gateways": [ "550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440001" ] }
  
curl --request POST \
  --url https://public-api.cipherscale.com/qa/tenants/resources//loadBalancing \
  --header 'Content-Type: application/json' \
  --header 'apikey: ' \
  --data '{
  "loadBalancingMode": "AUTOMATIC",
  "gateways": [
    "550e8400-e29b-41d4-a716-446655440000",
    "550e8400-e29b-41d4-a716-446655440001"
  ]
}'
Successfully applied load balancing configuration

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

Connection between a network address and a gateway

addressIdstringrequired

Unique identifier of the network address

Example:550e8400-e29b-41d4-a716-446655440000

gatewayIdstringrequired

Unique identifier of the gateway

Example:550e8400-e29b-41d4-a716-446655440001

post/tenants/resources/{id}/gateways

Body

{
  "gateways": [
    "[]"
  ]
}
{ "gateways": [ "[]" ] }
  
curl --request POST \
  --url https://public-api.cipherscale.com/qa/tenants/resources//gateways \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: ' \
  --data '{
  "gateways": [
    "[]"
  ]
}'
application/json
{
  "addressId": "550e8400-e29b-41d4-a716-446655440000",
  "gatewayId": "550e8400-e29b-41d4-a716-446655440001"
}

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}
  
curl --request DELETE \
  --url https://public-api.cipherscale.com/qa/tenants/resources//gateways/ \
  --header 'Content-Type: application/json' \
  --header 'apikey: '
Successfully disconnected resource from gateway

Addresses

Network address and endpoint management