Search
K
Cipherscale API

Test Gateway Configuration

Validates the gateway configuration by performing connectivity tests and verifying that all settings are properly configured. This helps identify configuration issues before deployment.

post
https://public-api.cipherscale.com/qa/tenants/gateways/{id}/test-configuration

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the gateway

Response

200 application/json
object
post/tenants/gateways/{id}/test-configuration
 
200 application/json

Resources

Network resource definition and access control

Create Network Resource

Creates a new network resource that defines access points for users and devices. Resources can be private networks, SaaS applications, or internet access points, each with specific protocols and access controls.

post
https://public-api.cipherscale.com/qa/tenants/resources

Body

application/json

CreateResourceDto

addressesarray[object]required
Show Child Parameters
namestringrequired
typestringrequired

Allowed values:PRIVATESAASINTERNET

descriptionstring

Response

application/json

Successfully created the resource

ResourceDto

idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
typestringrequired

Allowed values:PRIVATESAASINTERNET

loadBalancingModestringrequired

Allowed values:MANUALAUTOMATIC

Default:MANUAL

statusstring

Allowed values:ONLINEOFFLINE

descriptionstring
addressesarray[object]required
Show Child Parameters
gatewaysarray[object]required

Network gateway configuration and status information

Show Child Parameters
post/tenants/resources

Body

{ "addresses": [ { "protocols": [ "[]" ], "address": "address" } ], "name": "name", "type": "PRIVATE" }
 
application/json

List Network Resources

Retrieves a paginated list of all network resources for the tenant with advanced filtering and sorting capabilities. Supports filtering by resource type, gateway associations, protocols, and other criteria to help manage complex network topologies.

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

Query Parameters

sortstring

Sort order in format “field:direction”. Sortable fields: id, name. Direction: asc, desc

Example:-name

limitnumber
offsetnumber
filter[policies.id]string

Filter resources by policy ID (UUID format)

Example:123e4567-e89b-12d3-a456-426614174000

filter[gateways.id]string

Filter resources by gateway ID (UUID format)

Example:123e4567-e89b-12d3-a456-426614174000

filter[addresses.protocols.id]string

Filter resources by protocol ID in addresses (UUID format)

Example:123e4567-e89b-12d3-a456-426614174000

filter[type]string

Filter resources by type

Allowed values:PRIVATESAASINTERNET

filter[name]string

Filter resources by name

Example:Resource Name

filter[id]string

Filter resources by ID (UUID format)

Example:123e4567-e89b-12d3-a456-426614174000

page[offset]number

Number of resources to skip (minimum: 0)

Example:0

page[limit]number

Number of resources to return per page (minimum: 1)

Example:10

Response

application/json

Successfully retrieved resources

PaginatedDto

PaginatedDtoobject
get/tenants/resources
 
application/json

Update Network Resource

Modifies the configuration of an existing network resource including its name, description, and other properties. Changes may affect access policies and user permissions.

patch
https://public-api.cipherscale.com/qa/tenants/resources/{id}

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the resource to update

Body

application/json

UpdateResourceDto

namestringrequired
descriptionstring

Response

Successfully updated the resource

patch/tenants/resources/{id}

Body

{ "name": "name" }