Discovery needs no key. Ratings and market analysis are Pro.
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: Spyderbat API UI & Public Forwarded Events API
description: Restful APIs for use by UI & customers.
termsOfService: https://www.spyderbat.com/terms-of-use/
contact:
name: API Support
url: https://api.prod.spyderbat.com/openapi
email: support@spyderbat.com
license:
name: MIT
url: https://mit-license.org/
version: 1.0.0
x-logo:
url: /static/sb-logo.svg
backgroundColor: '#161A21'
altText: Spyderbat Logo
servers:
- url: https://api.prod.spyderbat.com/
description: Spyderbat API Server
security:
- apiToken: []
tags:
- name: ForwardedEvents
description: An API to allow retrieval of observations for a SIEM.
paths:
/api/v1/org/{orgUID}/events/*iterator:
get:
tags:
- ForwardedEvents
summary: Query for forwarded events for a 3rd-party SIEM
description: 'Return forwarded events using the supplied iterator. OLDEST will return the oldest
events, LATEST will return return an iterator for the current end of the stream.
If no iterator is provided, OLDEST will be used.
* Requires the action *source_data:Query* on the organization'
operationId: ForwardEvents
parameters:
- name: orgUID
in: path
description: Organization UID
required: true
schema:
type: string
description: Organization UID
- name: limit
in: query
description: Requested event count. A request of 10000 lets the server deliver as many events as it wants; smaller values are honored as a strict upper bound.
schema:
type: integer
description: Requested event count. A request of 10000 lets the server deliver as many events as it wants; smaller values are honored as a strict upper bound.
format: int32
maximum: 10000
minimum: 1000
responses:
'200':
description: OK
'403':
description: permission denied
'404':
description: not found
components:
securitySchemes:
apiToken:
type: http
scheme: bearer
bearerFormat: JWT