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. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: ATLAS Watchboxes API
version: 0.3.3
tags:
- name: Watchboxes
paths:
/api/v1/watchboxes:
get:
summary: Watchboxes List
description: 'Scoped to the caller: an owner token lists that owner''s boxes, nothing else.
The unscoped version of this route was the reconnaissance step of the whole attack —
it handed a stranger the ids and bboxes that the delete and log routes key on.'
operationId: watchboxes_list_api_v1_watchboxes_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Watchboxes List Api V1 Watchboxes Get
tags:
- Watchboxes
post:
summary: Watchboxes Create
operationId: watchboxes_create_api_v1_watchboxes_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WatchboxCreateBody'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Watchboxes Create Api V1 Watchboxes Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Watchboxes
/api/v1/watchboxes/{watchbox_id}:
get:
summary: Watchboxes Get
operationId: watchboxes_get_api_v1_watchboxes__watchbox_id__get
parameters:
- name: watchbox_id
in: path
required: true
schema:
type: string
title: Watchbox Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Watchboxes Get Api V1 Watchboxes Watchbox Id Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Watchboxes
delete:
summary: Watchboxes Delete
description: 'Unsubscribe by default; purge only on an explicit operator request.
DELETE used to drop the registry row, which orphaned the monitor log — the signed
checks survived in SQLite but nothing could reach them, because the log route
resolves the registry first. Making evidence unreachable is a worse outcome than
refusing to delete, so the default is a soft unsubscribe: the loop stops checking,
the owner keeps reading. `?purge=true` is the deliberate, operator-only way to
destroy the row, and it says in the response what it cost.'
operationId: watchboxes_delete_api_v1_watchboxes__watchbox_id__delete
parameters:
- name: watchbox_id
in: path
required: true
schema:
type: string
title: Watchbox Id
- name: purge
in: query
required: false
schema:
type: boolean
description: 'Operator-only: also destroy the registry row'
default: false
title: Purge
description: 'Operator-only: also destroy the registry row'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Watchboxes Delete Api V1 Watchboxes Watchbox Id Delete
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Watchboxes
/api/v1/watchboxes/{watchbox_id}/log:
get:
summary: Watchboxes Log
description: 'The monitoring-evidence artifact: what THIS instance checked, and when.
This is the half of a watchbox that is worth paying for. A signature over a NASA
FIRMS reading proves nothing the opposing party cannot fetch themselves; a signed,
append-only record that we evaluated this bbox at 09:56:10Z — at a cadence the buyer
did not choose after the fact — is what answers "prove you were monitoring".
Readable by the owner (and the operator) for as long as the registry row exists —
including after an unsubscribe, which is exactly when a buyer is most likely to need
it.'
operationId: watchboxes_log_api_v1_watchboxes__watchbox_id__log_get
parameters:
- name: watchbox_id
in: path
required: true
schema:
type: string
title: Watchbox Id
- name: limit
in: query
required: false
schema:
type: integer
default: 200
title: Limit
- name: since
in: query
required: false
schema:
type: string
default: ''
title: Since
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Watchboxes Log Api V1 Watchboxes Watchbox Id Log Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Watchboxes
/api/v1/watchboxes/{watchbox_id}/check:
post:
summary: Watchboxes Check
description: 'Paid-style evaluation — ``atlas.watchbox.check@v1``.
Owner-gated like the rest: a stored watchbox''s bbox and layers are the tenant''s, and
this route echoes both. Ephemeral bbox checks (no stored id) stay open on
``/ai-market/v2/invoke``.'
operationId: watchboxes_check_api_v1_watchboxes__watchbox_id__check_post
parameters:
- name: watchbox_id
in: path
required: true
schema:
type: string
title: Watchbox Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Watchboxes Check Api V1 Watchboxes Watchbox Id Check Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Watchboxes
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
WatchboxCreateBody:
properties:
west:
type: number
maximum: 180.0
minimum: -180.0
title: West
south:
type: number
maximum: 90.0
minimum: -90.0
title: South
east:
type: number
maximum: 180.0
minimum: -180.0
title: East
north:
type: number
maximum: 90.0
minimum: -90.0
title: North
layers:
items:
type: string
type: array
minItems: 1
title: Layers
label:
type: string
maxLength: 120
title: Label
default: ''
webhook_url:
anyOf:
- type: string
- type: 'null'
title: Webhook Url
id:
anyOf:
- type: string
maxLength: 64
- type: 'null'
title: Id
type: object
required:
- west
- south
- east
- north
- layers
title: WatchboxCreateBody