Skip to main content
Documentation Powered by Redocly

PolyScale API (0.0.138)

Download OpenAPI specification:Download

Terms of Service

cache

Get caches

Retrieves all caches in the workspace associated with the provided api key.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a cache

Creates a cache in the workspace associated with the provided api key.

Authorizations:
bearerAuth
Request Body schema: application/json
name
required
string non-empty
description
string <= 250 characters
host
required
string non-empty
port
required
number <= 65535
cachingEnabled
required
boolean
defaultCachingBehaviour
required
string
Enum: "autoCached" "uncached"
database
required
string
Enum: "mysql" "mariadb" "postgres" "mssql" "graphql" "mongodb"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "host": "string",
  • "port": 65535,
  • "cachingEnabled": true,
  • "defaultCachingBehaviour": "autoCached",
  • "database": "mysql"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "host": "string",
  • "port": 0,
  • "cachingEnabled": true,
  • "database": "mysql",
  • "defaultCachingBehaviour": "autoCached",
  • "createdAt": "string",
  • "connectionUriTemplate": "string",
  • "workspaceId": "string",
  • "connectionPool": {
    }
}

Get a cache

Retrieves a specific cache in the workspace associated with the provided api key.

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "host": "string",
  • "port": 0,
  • "cachingEnabled": true,
  • "database": "mysql",
  • "defaultCachingBehaviour": "autoCached",
  • "createdAt": "string",
  • "connectionUriTemplate": "string",
  • "workspaceId": "string",
  • "connectionPool": {
    }
}

Update a cache

Updates a cache in the workspace associated with the provided api key.

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
description
string
cachingEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "cachingEnabled": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "host": "string",
  • "port": 0,
  • "cachingEnabled": true,
  • "database": "mysql",
  • "defaultCachingBehaviour": "autoCached",
  • "createdAt": "string",
  • "connectionUriTemplate": "string",
  • "workspaceId": "string",
  • "connectionPool": {
    }
}

Purge a cache

Purge a cache in the workspace associated with the provided api key.

Authorizations:
bearerAuth
path Parameters
cacheId
required
string

Responses

Delete a cache

Delete a cache in the workspace associated with the provided api key.

Authorizations:
bearerAuth
path Parameters
cacheId
required
string

Responses

cacheTtl

Get cache ttls

Get cache ttls of a cache in the workspace associated with the provided api key.

Authorizations:
bearerAuth
path Parameters
cacheId
required
string

Responses

Create a cache ttl

Craete a cache ttl for a cache in the workspace associated with the provided api key.

Authorizations:
bearerAuth
path Parameters
cacheId
required
string
Request Body schema: application/json
One of
type
required
string
Enum: "MANUAL" "AUTO"
key
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "QUERY",
  • "key": "string",
  • "value": 0,
  • "name": "string",
  • "sql": "string"
}

Get a cache ttl

Retrieve a cache ttl of a cache in the workspace associated with the provided api key.

Authorizations:
bearerAuth
path Parameters
cacheId
required
string
key
required
string
type
required
string
Enum: "AUTO" "MANUAL" "QUERY" "TEMPLATE" "TABLE"

Responses

Update a cache ttl

Update a cache ttl for a cache in the workspace associated with the provided api key.

Authorizations:
bearerAuth
path Parameters
cacheId
required
string
key
required
string
Request Body schema: application/json
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Delete a cache ttl

Delete a cache ttl for a cache in the workspace associated with the provided api key.

Authorizations:
bearerAuth
path Parameters
cacheId
required
string
key
required
string
type
required
string
Enum: "AUTO" "MANUAL" "QUERY" "TEMPLATE" "TABLE"

Responses