Search
K
Cipherscale API

Resource

object

Complete network resource information with addresses and gateways

idstring(uuid)required

Unique identifier for the resource

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

createdAtstring(date-time)required

Timestamp when the resource was created

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

updatedAtstring(date-time)required

Timestamp when the resource was last updated

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

namestringrequired

Human-readable name for the resource

Example:Internal Web Server

typestringrequired

Type of the network resource

Allowed values:PRIVATESAASINTERNET

Example:PRIVATE

loadBalancingModestringrequired

Load balancing configuration for this resource

Allowed values:MANUALAUTOMATIC

Default:MANUAL

Example:MANUAL

statusstring

Current operational status of the resource

Allowed values:ONLINEOFFLINE

Example:ONLINE

descriptionstring

Detailed description of the resource’s purpose

Example:Internal web server for company applications

addressesarray[object]required

Array of network addresses associated with this resource

Example:{"id":"550e8400-e29b-41d4-a716-446655440001","address":"192.168.1.100","isIp":true,"type":"PRIVATE","protocols":[{"id":"550e8400-e29b-41d4-a716-446655440000","name":"HTTP/HTTPS","type":"PREDEFINED","networkProtocols":[{"protocol":"TCP","port":"80"},{"protocol":"TCP","port":"443"}]}]}

Show Child Parameters
gatewaysarray[object]required

Network gateway configuration and status information

Show Child Parameters
Example
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2023-01-15T14:30:00Z",
  "updatedAt": "2023-01-15T14:30:00Z",
  "name": "Internal Web Server",
  "type": "PRIVATE",
  "loadBalancingMode": "MANUAL",
  "status": "ONLINE",
  "description": "Internal web server for company applications",
  "addresses": [],
  "gateways": []
}

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
{
  "totalCount": 0,
  "onlineCount": 0,
  "offlineCount": 0,
  "withoutGatewayCount": 0,
  "withoutPolicyCount": 0
}

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
{
  "name": "Internal Web Server",
  "description": "Internal web server for company applications"
}

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"
  ]
}