Search
K
Cipherscale API

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

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

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

GroupUser

object

User information within a group context

idstring(uuid)required

Unique identifier for the user

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

createdAtstring(date-time)required

Timestamp when the user was added to the group

Example:2023-01-15T10:30:00Z

updatedAtstring(date-time)required

Timestamp when the user’s group membership was last modified

Example:2023-01-15T10:30:00Z

firstNamestringrequired

User’s first name

Example:John

lastNamestringrequired

User’s last name

Example:Doe

emailstringrequired

User’s email address

Example:john.doe@company.com

Example