Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: CacheBoost Auth API
version: '1'
description: 'The CacheBoost API lets you manage sites, sitemaps, boosts, and runs
programmatically. All endpoints are under `/v1`.'
servers:
- url: https://api.cache-boost.com/v1
description: Production
security:
- bearerAuth: []
tags:
- name: Auth
paths:
/me:
get:
operationId: getMe
summary: Get current key
description: Returns the identity and scopes granted to the authenticated API key. Useful for connectivity checks and verifying that the key has the required permissions.
tags:
- Auth
security:
- bearerAuth: []
responses:
'200':
description: Key identity and scopes
content:
application/json:
schema:
type: object
properties:
user_id:
type: integer
example: 42
scopes:
type: array
items:
type: string
example:
- sites:read
- boosts:read
- boosts:write
site_ids:
type: array
nullable: true
items:
type: integer
description: null when the key has access to all sites, or an array of allowed site IDs.
example: null
required:
- user_id
- scopes
- site_ids
'401':
$ref: '#/components/responses/Unauthorized'
components:
schemas:
Error:
type: object
properties:
error:
type: string
example: Description of the error.
responses:
Unauthorized:
description: Missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: API key in the format `cb_live_<32hex>`