Search
K
Cipherscale API

PaginatedResponse

object

Paginated response containing data and pagination metadata

dataarray

Array of items for the current page

totalinteger

Total number of items across all pages for the given filters. Use this with “limit” to compute total pages: totalPages = ceil(total / limit).

pageinteger

Current page index (0-based). For offset-based pagination, page = floor(offset / limit). For page[] style, this equals the N used in page[offset] = N × page[limit].

limitinteger

Number of items per page returned in this response. Mirrors the query “limit” or “page[limit]” parameter used for the request.

hasNextboolean

Whether there are more pages available

hasPreviousboolean

Whether there are previous pages available

Example
{
  "data": [
    "[]"
  ],
  "total": 0,
  "page": 0,
  "limit": 0,
  "hasNext": false,
  "hasPrevious": false
}

UpdateUser

object

Data for updating user profile information

firstNamestring

User’s first name

Example:Jane

lastNamestring

User’s last name

Example:Smith

imagestring

URL or path to the user’s profile image

Example:https://example.com/avatars/jane-smith.jpg

Example
{
  "firstName": "Jane",
  "lastName": "Smith",
  "image": "https://example.com/avatars/jane-smith.jpg"
}

UpdateUserRoles

object

Data for adding or removing roles from a user

addedRolesarray[string]required

Array of role IDs to add to the user

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

removedRolesarray[string]required

Array of role IDs to remove from the user

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

Example
{
  "addedRoles": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "removedRoles": [
    "550e8400-e29b-41d4-a716-446655440001"
  ]
}

CreateGateway

object

Data required to create a new network gateway

namestringrequired

Human-readable name for the gateway

Example:US-East Gateway

descriptionstring

Detailed description of the gateway’s purpose and location

Example:Primary gateway for US East region data center

wireguardPortstringrequired

WireGuard VPN port number for this gateway

Example:51820

endpointstring

Network endpoint address for the gateway

Example:gateway-us-east.company.com

Example
{
  "name": "US-East Gateway",
  "description": "Primary gateway for US East region data center",
  "wireguardPort": "51820",
  "endpoint": "gateway-us-east.company.com"
}

GatewayResource

object

Resource information accessible through a gateway

idstring(uuid)required

Unique identifier for the resource

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

namestringrequired

Human-readable name for the resource

Example:Internal Web Server

Example
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Internal Web Server"
}