idstring(uuid)required
The unique identifier (UUID) of the resource
Get Resource Details
Retrieves comprehensive information about a specific network resource including its configuration, associated addresses, protocols, gateway connections, and load balancing settings.
get
https://public-api.cipherscale.com/qa/tenants/resources/{id}
Path Parameters
Response
application/json
Response
application/json
Successfully retrieved the resource
Resource
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
get/tenants/resources/{id}
Authentication
Path Parameters
application/json
Remove Network Resource
Permanently removes a network resource from the tenant. The resource must not be linked to any active policies before deletion. This operation will also disconnect all associated gateway connections.
delete
https://public-api.cipherscale.com/qa/tenants/resources/{id}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the resource to delete
Response
Response
Successfully deleted the resource
delete/tenants/resources/{id}
Authentication
Path Parameters
Configure Resource Load Balancing
Configures load balancing settings for a resource, determining how traffic is distributed across multiple gateways. Supports both manual gateway selection and automatic load balancing algorithms.
post
https://public-api.cipherscale.com/qa/tenants/resources/{id}/loadBalancing
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the resource
Body
application/json
Body
application/json
ApplyLoadBalancing
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"]
Response
Response
Successfully applied load balancing configuration
post/tenants/resources/{id}/loadBalancing
Authentication
Path Parameters
Body
{
"loadBalancingMode": "AUTOMATIC",
"gateways": [
"550e8400-e29b-41d4-a716-446655440000",
"550e8400-e29b-41d4-a716-446655440001"
]
}
Connect Resource to Gateways
Establishes network connections between a resource and one or more gateways, enabling users to access the resource through those gateways. This operation is essential for defining network topology and access paths.
post
https://public-api.cipherscale.com/qa/tenants/resources/{id}/gateways
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the resource
Body
application/json
Body
application/json
gatewaysarray[string](uuid)required
Comma-separated list of gateway IDs
Response
application/json
Response
application/json
Successfully created resource-gateway connections
Connection between a network address and a gateway
addressIdstringrequired
Unique identifier of the network address
Example:550e8400-e29b-41d4-a716-446655440000
gatewayIdstringrequired
Unique identifier of the gateway
Example:550e8400-e29b-41d4-a716-446655440001
post/tenants/resources/{id}/gateways
Authentication
Path Parameters
Body
{
"gateways": [
"[]"
]
}
application/json
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
Response
Successfully disconnected resource from gateway
delete/tenants/resources/{id}/gateways/{gatewayId}