Cipherscale API

Disconnect Resource from Gateway

Removes the network connection between a resource and a specific gateway, preventing access to the resource through that gateway. This operation helps manage network topology and access control.

delete
https://public-api.cipherscale.com/qa/tenants/resources/{id}/gateways/{gatewayId}

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the resource

gatewayIdstring(uuid)required

The unique identifier (UUID) of the gateway to disconnect

Response

Successfully disconnected resource from gateway

delete/tenants/resources/{id}/gateways/{gatewayId}
 

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
addressstringrequired
isIpbooleanrequired
typestringrequired

Allowed values:PRIVATESAASINTERNET

protocolsarray[object]required
Show Child Parameters
get/tenants/addresses
 
application/json

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

AddressDto

idstring(uuid)required
addressstringrequired
isIpbooleanrequired
typestringrequired

Allowed values:PRIVATESAASINTERNET

protocolsarray[object]required
Show Child Parameters
get/tenants/addresses/{id}
 
application/json

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

UpdateAddressDto

protocolsarray[string](uuid)required
addressstringrequired

Response

application/json

Successfully updated the address

AddressDto

idstring(uuid)required
addressstringrequired
isIpbooleanrequired
typestringrequired

Allowed values:PRIVATESAASINTERNET

protocolsarray[object]required
Show Child Parameters
put/tenants/addresses/{id}

Body

{ "protocols": [], "address": "address" }
 
application/json