Search
K
Cipherscale API

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
{
  "address": "192.168.1.100",
  "protocols": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

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
{
  "loadBalancingMode": "AUTOMATIC",
  "gateways": [
    "550e8400-e29b-41d4-a716-446655440000",
    "550e8400-e29b-41d4-a716-446655440001"
  ]
}

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
{
  "address": "192.168.1.100",
  "protocols": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

CreateProtocol

object

Data required to create a new network protocol definition

namestring

Human-readable name for the protocol

Example:Custom Web Services

networkProtocolsarray[object]required

Array of network protocol configurations (TCP, UDP, ICMP)

Example:{"protocol":"TCP","port":"80"}

Show Child Parameters
Example
{
  "name": "Custom Web Services",
  "networkProtocols": [
    {
      "protocol": "TCP",
      "port": "8080"
    },
    {
      "protocol": "TCP",
      "port": "8443"
    }
  ]
}

CreateGroup

object

Data required to create a new user group

rolesarray[string]required

Array of role IDs to assign to the group

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

namestringrequired

Human-readable name for the group

Example:Marketing Team

descriptionstring

Detailed description of the group’s purpose and scope

Example:Marketing team with access to customer data and analytics tools

Example
{
  "name": "Marketing Team",
  "description": "Marketing team with access to customer data and analytics tools",
  "roles": [
    "550e8400-e29b-41d4-a716-446655440000",
    "550e8400-e29b-41d4-a716-446655440001"
  ]
}