Search
K
Cipherscale API

Update Network Resource

Modifies the configuration of an existing network resource including its name, description, and other properties. Changes may affect access policies and user permissions.

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

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the resource to update

Body

application/json

UpdateResourceDto

namestringrequired
descriptionstring

Response

Successfully updated the resource

patch/tenants/resources/{id}

Body

{ "name": "name" }
 

Get Resource Details

Retrieves comprehensive information about a specific network resource including its configuration, associated addresses, protocols, gateway connections, and load balancing settings.

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

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the resource

Response

application/json

Successfully retrieved the resource

ResourceDto

idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
typestringrequired

Allowed values:PRIVATESAASINTERNET

loadBalancingModestringrequired

Allowed values:MANUALAUTOMATIC

Default:MANUAL

statusstring

Allowed values:ONLINEOFFLINE

descriptionstring
addressesarray[object]required
Show Child Parameters
gatewaysarray[object]required

Network gateway configuration and status information

Show Child Parameters
get/tenants/resources/{id}
 
application/json

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}
 

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