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: Ctlogs Io Stats API
version: 1.0.0
contact:
url: https://ctlogs.io/docs
description: 'Operations tagged Stats across 2 of this provider''s published API definitions: ctlogs-io-openapi.json, ctlogs-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.ctlogs.io
security:
- ApiKeyHeader: []
tags:
- name: Stats
paths:
/v1/stats:
get:
operationId: getStats
summary: Index size and freshness
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/Envelope'
'401':
$ref: '#/components/responses/Unauthorized'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'429':
$ref: '#/components/responses/TooManyRequests'
'503':
$ref: '#/components/responses/Unavailable'
tags:
- Stats
servers:
- url: https://api.ctlogs.io
components:
responses:
MethodNotAllowed:
description: every endpoint is read-only; only GET and HEAD are answered
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: missing, unknown or revoked key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
TooManyRequests:
description: hourly bucket spent, or too many in flight
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unavailable:
description: the index could not be reached; this is not the same as no results
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Envelope:
type: object
required:
- status
- count
- data
properties:
status:
type: string
const: ok
count:
type: integer
description: rows in data on this page
elapsed:
type: string
description: server-side time, Go duration format
next_cursor:
type: string
description: present only when another page exists
data:
type: array
items:
type: object
Error:
type: object
required:
- status
properties:
status:
type: string
const: error
error:
type: string
message:
type: string
request_id:
type: string
securitySchemes:
ApiKeyHeader:
type: apiKey
in: header
name: X-API-Key
description: A ?key= query parameter is also accepted but writes the key into proxy logs and Referer headers. Plain HTTP is refused, not redirected.
x-refined-from:
- ctlogs-io-openapi.json
- ctlogs-io-openapi.yml