Search
K
Cipherscale API

ResourceTypeStatistics

object
totalCountnumberrequired

Total number of resources

onlineCountnumberrequired

Number of online resources

offlineCountnumberrequired

Number of offline resources

withoutGatewayCountnumberrequired

Number of resources without a gateway

withoutPolicyCountnumberrequired

Number of resources without a policy

Example

UpdateResource

object

Data for updating an existing network resource

namestringrequired

Human-readable name for the resource

Example:Internal Web Server

descriptionstring

Detailed description of the resource’s purpose

Example:Internal web server for company applications

Example

SimpleAddress

object
protocolsarray[string](uuid)required

Array of protocol IDs (UUIDs) associated with this address

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

addressstringrequired

Network address (IP address or domain name)

Example:192.168.1.100

Example

ApplyLoadBalancing

object

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

Example

UpdateAddress

object
protocolsarray[string](uuid)required

Array of protocol IDs (UUIDs) to associate with this address

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

addressstringrequired

Network address (IP address or domain name)

Example:192.168.1.100

Example