Search
K
Cipherscale API

Addresses

Network address and endpoint management

List All Network Addresses

Retrieves all network addresses configured for the tenant, including IP addresses, hostnames, and domain names with their associated protocols and access types.

get
https://public-api.cipherscale.com/qa/tenants/addresses

Response

application/json

Successfully retrieved addresses

idstring(uuid)required

Unique identifier for the address

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

addressstringrequired

Network address (IP address or domain name)

Example:192.168.1.100

isIpbooleanrequired

Whether the address is an IP address (true) or domain name (false)

Example:true

typestringrequired

Type of network resource this address belongs to

Allowed values:PRIVATESAASINTERNET

Example:PRIVATE

protocolsarray[object]required

Array of protocol objects defining network protocols for this address

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

Show Child Parameters
get/tenants/addresses
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/addresses \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
application/json
{
  "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"
        }
      ]
    }
  ]
}

Get Address Details

Retrieves detailed information about a specific network address including its type, associated protocols, and linked gateways.

get
https://public-api.cipherscale.com/qa/tenants/addresses/{id}

Path Parameters

idstringrequired

The unique identifier of the address

Response

application/json

Successfully retrieved the address

Address

idstring(uuid)required

Unique identifier for the address

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

addressstringrequired

Network address (IP address or domain name)

Example:192.168.1.100

isIpbooleanrequired

Whether the address is an IP address (true) or domain name (false)

Example:true

typestringrequired

Type of network resource this address belongs to

Allowed values:PRIVATESAASINTERNET

Example:PRIVATE

protocolsarray[object]required

Array of protocol objects defining network protocols for this address

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

Show Child Parameters
get/tenants/addresses/{id}
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/addresses/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
application/json
{
  "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"
        }
      ]
    }
  ]
}

Update Network Address

Modifies the configuration of an existing network address including its associated protocols and access settings.

put
https://public-api.cipherscale.com/qa/tenants/addresses/{id}

Path Parameters

idstringrequired

The unique identifier of the address to update

Body

application/json

The address data to update

UpdateAddress

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

Response

application/json

Successfully updated the address

Address

idstring(uuid)required

Unique identifier for the address

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

addressstringrequired

Network address (IP address or domain name)

Example:192.168.1.100

isIpbooleanrequired

Whether the address is an IP address (true) or domain name (false)

Example:true

typestringrequired

Type of network resource this address belongs to

Allowed values:PRIVATESAASINTERNET

Example:PRIVATE

protocolsarray[object]required

Array of protocol objects defining network protocols for this address

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

Show Child Parameters
put/tenants/addresses/{id}

Body

{
  "address": "192.168.1.100",
  "protocols": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}
{ "address": "192.168.1.100", "protocols": [ "550e8400-e29b-41d4-a716-446655440000" ] }
  
curl --request PUT \
  --url https://public-api.cipherscale.com/qa/tenants/addresses/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "address": "192.168.1.100",
  "protocols": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}'
application/json
{
  "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"
        }
      ]
    }
  ]
}

Remove Network Address

Permanently removes a network address from the tenant. This operation will also remove the address from any associated resources.

delete
https://public-api.cipherscale.com/qa/tenants/addresses/{id}

Path Parameters

idstringrequired

The unique identifier of the address to delete

Response

Successfully deleted the address

delete/tenants/addresses/{id}
  
curl --request DELETE \
  --url https://public-api.cipherscale.com/qa/tenants/addresses/ \
  --header 'Content-Type: application/json'
Successfully deleted the address