Get caches
Retrieves all caches in the workspace associated with the provided api key.
Authorizations:
bearerAuth
Responses
Response samples
- 200
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"
}
]
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 |
cachingEnabled required | boolean |
defaultCachingBehaviour required | string Enum: "autoCached" "uncached" |
database required | string Enum: "mysql" "mariadb" "postgres" "mssql" "graphql" |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "description": "string",
- "host": "string",
- "port": 0,
- "cachingEnabled": true,
- "defaultCachingBehaviour": "autoCached",
- "database": "mysql"
}
Response samples
- 200
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"
}
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
- 200
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"
}
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
- Payload
Content type
application/json
{- "name": "string",
- "description": "string",
- "cachingEnabled": true
}
Response samples
- 200
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"
}
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
- Payload
Content type
application/json
{- "type": "QUERY",
- "key": "string",
- "value": 0,
- "name": "string",
- "sql": "string"
}
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
- Payload
Content type
application/json
{- "value": 0
}