Search
K
Cipherscale API

CreateAddress

object
protocolsarray[string](uuid)required

Array of protocol IDs (UUIDs) that define the network protocols for this address. Use the “List Network Protocols” endpoint to get available protocol IDs, or create new protocols using the “Create Network Protocol” endpoint.

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

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",
    "550e8400-e29b-41d4-a716-446655440001"
  ]
}

CreateResource

object
addressesarray[object]required

Array of network addresses with their associated protocols. Protocol IDs can be obtained from the “List Network Protocols” endpoint or created using the “Create Network Protocol” endpoint.

Example:{"address":"192.168.1.100","protocols":["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]}

Show Child Parameters
namestringrequired

Name of the network resource

Example:Internal Web Server

typestringrequired

Type of network resource

Allowed values:PRIVATESAASINTERNET

Example:PRIVATE

descriptionstring

Optional description of the resource

Example:Internal web server for company applications

Example
{
  "name": "Internal Web Server",
  "type": "PRIVATE",
  "description": "Internal web server for company applications",
  "addresses": [
    {
      "address": "192.168.1.100",
      "protocols": [
        "550e8400-e29b-41d4-a716-446655440000",
        "550e8400-e29b-41d4-a716-446655440001"
      ]
    }
  ]
}

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