How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Spyderbat Spyctl API

A way to execute specific Spyctl logic via the API.

Spyderbat Spyctl API is one of 29 APIs that Spyderbat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Spyctl. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 12 operations across 11 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.prod.spyderbat.com/.

12 operations 11 paths 22 schemas 1 DELETE4 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.prod.spyderbat.com/api/v1
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Spyderbat Spyctl API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (apiToken). By default, every request must be authenticated.

Paths & Operations 12

Across 11 paths, the API surfaces 12 operations — 1 DELETE, 4 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Spyctl 12

A way to execute specific Spyctl logic via the API.

POST
/api/v1/org/{orgUID}/spyctl/diff/
Diff spyderbat documents
SpyctlDiff 1 param body → 200400403
POST
/api/v1/org/{orgUID}/spyctl/guardianpolicy/build/
Build a new Guardian Policy document
GuardianPolicyBuild 1 param body → 200400403
POST
/api/v1/org/{orgUID}/spyctl/merge/
Merge spyderbat documents
SpyctlMerge 1 param body → 200400403
POST
/api/v1/org/{orgUID}/spyctl/report
Generate a spyderbat report
SpyctlReportGenerate 1 param body → 200400403
GET
/api/v1/org/{orgUID}/spyctl/report/
Get list of spyderbat reports for an org
SpyctlReportList 1 param → 200400403
POST
/api/v1/org/{orgUID}/spyctl/report/
Get list of spyderbat reports for an org, paginated
SpyctlReportListPager 1 param body → 200400403
GET
/api/v1/org/{orgUID}/spyctl/report/download/{id.format}
Download a spyderbat report
SpyctlReportDownload 2 params → 200400403
GET
/api/v1/org/{orgUID}/spyctl/report/inventory
Report inventory of spyderbat reports
SpyctlReportInventory 1 param → 200400403
GET
/api/v1/org/{orgUID}/spyctl/report/status/{id}
Check status of spyderbat report
SpyctlReportStatus 2 params → 200400403
DELETE
/api/v1/org/{orgUID}/spyctl/report/{id}
Delete a spyderbat report
SpyctlReportDelete 2 params → 200400403
POST
/api/v1/org/{orgUID}/spyctl/suppressionpolicy/build/
Build a new Suppression Policy document
SuppressionPolicyBuild 1 param body → 200400403
POST
/api/v1/org/{orgUID}/spyctl/validate/
Validate a spyderbat document
SpyctlValidate 1 param body → 200400403

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are SessionSpyctlReportOutput (7 properties), SessionSpyctlReportSpecArgument (6 properties), SpyctlDiffInput (5 properties), SuppressionPolicyBuildInput (5 properties). Each schema is shown below with its type and property counts.

SessionSpyctlDiffOutput
object
3 properties
SpyctlValidateInput
object
1 property 1 required
SpyctlMergeInput
object
2 properties 2 required
SessionSpyctlReportListOutput
object
2 properties
SessionSpyctlReportInventoryOutput
object
2 properties
SessionSpyctlMergeOutput
object
2 properties
SessionSpyctlReportDeleteOutput
object
1 property
SessionSpyctlReportListPagerOutput
object
3 properties
SessionSpyctlGuardianPolicyBuildOutput
object
2 properties
SpyctlDiffInput
object
5 properties 2 required
SuppressionPolicyBuildInput
object
5 properties 1 required
SessionSpyctlReportSpec
object
5 properties
ValidationError
object
4 properties
SessionSpyctlValidateOutput
object
2 properties
DaoPolicyObject
object
Policy
4 properties 4 required
SpyctlReportGenerateInput
object
3 properties 2 required
SpyctlReportListPagerInput
object
3 properties
DaoAnalyticResourceObject
object
The object to validate.
5 properties 3 required
SessionSpyctlReportSpecArgument
object
6 properties
SessionSpyctlSuppressionPolicyBuildOutput
object
2 properties
SessionSpyctlReportOutput
object
7 properties
GuardianPolicyBuildInput
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spyderbat-spyctl-api-openapi.yml Raw ↑

Other APIs Spyderbat publishes across the network.

Spyderbat Adhoc Search API
Spyderbat Agent Action API
Spyderbat Agent API
Spyderbat Agent Registration API
Spyderbat Agent Work API
Spyderbat Analytics Policy API
Spyderbat Analytics Ruleset API
Spyderbat Archive API
Spyderbat Cases API
Spyderbat Cluster API
Spyderbat Custom Flag API
Spyderbat Fingerprint Data API
Where this information came from

This is an independent, third-party profile of Spyderbat Spyctl API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.