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 Me API
version: 1.0.0
contact:
url: https://ctlogs.io/docs
description: 'Operations tagged Me 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: Me
paths:
/v1/me:
get:
operationId: getMe
summary: Your plan and the balance of each hourly bucket
description: Answered by the gateway itself. It costs no hourly quota and no prepaid credit, so a client may check it before deciding whether to spend a query. It does occupy a request slot, so it is subject to the plan's requests-per-second rate.
responses:
'200':
description: ok
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: ok
data:
type: object
properties:
key_prefix:
type: string
plan:
type: string
qps:
type: integer
query_timeout_seconds:
type: integer
page_size:
type: integer
concurrency:
type: integer
description: present only when the plan sets an in-flight limit
buckets:
type: object
properties:
hostname:
$ref: '#/components/schemas/Bucket'
full_domain:
$ref: '#/components/schemas/Bucket'
keyword:
$ref: '#/components/schemas/Bucket'
'401':
$ref: '#/components/responses/Unauthorized'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'429':
$ref: '#/components/responses/TooManyRequests'
tags:
- Me
servers:
- url: https://api.ctlogs.io
components:
responses:
Unauthorized:
description: missing, unknown or revoked key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
MethodNotAllowed:
description: every endpoint is read-only; only GET and HEAD are answered
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'
schemas:
Error:
type: object
required:
- status
properties:
status:
type: string
const: error
error:
type: string
message:
type: string
request_id:
type: string
Bucket:
type: object
properties:
limit:
type: integer
used:
type: integer
remaining:
type: integer
resets_at:
type: string
format: date-time
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