Spyderbat Agent API
Agents represent a sepecific agent which collects data for one or more sources.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/spyderbat-agent-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Spyderbat Agent API
version: 1.0.0
contact:
name: API Support
url: https://api.prod.spyderbat.com/openapi
email: support@spyderbat.com
license:
name: MIT
url: https://mit-license.org/
termsOfService: https://www.spyderbat.com/terms-of-use/
x-logo:
url: /static/sb-logo.svg
backgroundColor: '#161A21'
altText: Spyderbat Logo
description: 'Operations tagged Agent across 2 of this provider''s published API definitions: spyderbat-openapi-original.json, spyderbat-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.prod.spyderbat.com/
description: Spyderbat API Server
security:
- apiToken: []
tags:
- name: Agent
description: '
Agents represent a sepecific agent which collects data for one or more sources.
'
paths:
/api/v1/org/{orgUID}/agent/:
get:
tags:
- Agent
summary: List agents
description: '
Lists the agents associated with an organization
* Requires the action *agent:List* on the organization
'
operationId: AgentList
parameters:
- name: orgUID
in: path
required: true
schema:
type: string
- name: agent_registration_uid_equals
in: query
schema:
type: string
maxLength: 64
- name: is_archived
in: query
allowEmptyValue: true
schema:
type: boolean
- name: is_not_archived
in: query
allowEmptyValue: true
schema:
type: boolean
- name: original_association
in: query
allowEmptyValue: true
schema:
type: boolean
- name: page
in: query
schema:
type: integer
format: int32
- name: page_size
in: query
schema:
type: integer
format: int32
maximum: 100
- name: source_uid_equals
in: query
schema:
type: string
maxLength: 64
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Agent'
'403':
description: permission denied
servers:
- url: https://api.prod.spyderbat.com/
description: Spyderbat API Server
/api/v1/org/{orgUID}/agent/{agentUID}:
get:
tags:
- Agent
summary: Load an agent
description: '
Load a specified agent
* Requires the action *agent:Load* on the organization
'
operationId: AgentLoad
parameters:
- name: agentUID
in: path
required: true
schema:
type: string
- name: orgUID
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Agent'
'403':
description: permission denied
'404':
description: not found
servers:
- url: https://api.prod.spyderbat.com/
description: Spyderbat API Server
/api/v1/org/{orgUID}/agent/{agentUID}/archive:
put:
tags:
- Agent
summary: Archive (hide) an agent
description: '
Archive a specified agent. This marks that an agent and any associated sources should be hidden in the UI.
* Requires the action *agent:Archive* on the organization
'
operationId: AgentArchive
parameters:
- name: agentUID
in: path
required: true
schema:
type: string
- name: orgUID
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
'403':
description: permission denied
'404':
description: not found
servers:
- url: https://api.prod.spyderbat.com/
description: Spyderbat API Server
/api/v1/org/{orgUID}/agent/{agentUID}/unarchive:
put:
tags:
- Agent
summary: Unarchive (show) an agent
description: '
Unarchive a specified agent. This marks that an agent and any associated sources should be shown in the UI.
* Requires the action *agent:Unarchive* on the organization
'
operationId: AgentUnarchive
parameters:
- name: agentUID
in: path
required: true
schema:
type: string
- name: orgUID
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
'403':
description: permission denied
'404':
description: not found
servers:
- url: https://api.prod.spyderbat.com/
description: Spyderbat API Server
components:
schemas:
RbacStatement:
type: object
properties:
actions:
type: array
items:
type: string
description: The actions that may be performed
maxItems: 50
minItems: 1
condition:
$ref: '#/components/schemas/RbacConditionMap'
effect:
type: string
description: The effect of the statement, i.e. allow or deny
maxLength: 5
resources:
type: array
items:
type: string
description: The resource the statement applies to
maxItems: 25
minItems: 1
sid:
type: string
description: Statement ID, used to identify the statement in audit logs
maxLength: 32
required:
- effect
- sid
ResourcePolicy:
type: object
properties:
name:
type: string
description: Name of the resource policy
maxLength: 32
statements:
type: array
items:
$ref: '#/components/schemas/RbacStatement'
description: List of statements to be examined by the resource policy
version:
type: string
maxLength: 24
description: Resource policy for RBAC
RbacConditionMap:
type: object
description: Additional conditions which may be applied
Agent:
type: object
properties:
agent_registration_uid:
type: string
description: Agent registration associated with the agent
agent_type:
type: integer
description: Agent type
format: int32
agent_version:
type: string
description: Version of the agent installed
agent_work_id:
type: integer
description: Agent work Id
format: int32
archived:
type: boolean
description: Is the agent archived?
description:
type: string
description: Description of the purpose of the agent
kernel_version:
type: string
description: Kernel version of the installed system
live_test_ran:
type: integer
description: Did the live test run?
format: int32
live_test_result:
type: integer
description: Result of the live test
format: int32
muid:
type: string
description: Muid created on by the agent on the system
org_uid:
type: string
description: Agent OrgUID
os_pretty_name:
type: string
description: Pretty name of the operating system the agent is installed on
resource_name:
type: string
description: Resource name used for RBAC
resource_policy:
$ref: '#/components/schemas/ResourcePolicy'
runtime_description:
type: string
description: Description of the runtime of the agent
runtime_details:
$ref: '#/components/schemas/Orc_apiRuntimeDetails'
standby:
type: boolean
description: Is the agent in standby mode?
uid:
type: string
description: Agent UID
user_work_id:
type: integer
format: int32
valid_from:
type: string
description: Valid from date, the first date this object was valid
format: date-time
valid_to:
type: string
description: Valid to date, the date this object is valid to
format: date-time
Orc_apiRuntimeDetails:
type: object
properties:
agent_arch:
type: string
agent_registration_uid:
type: string
agent_status:
type: string
agent_type:
type: integer
format: int32
agent_uid:
type: string
agent_version:
type: string
boot_time:
type: number
format: double
cloud_account_id:
type: string
cloud_image_id:
type: string
cloud_instance_id:
type: string
cloud_region:
type: string
cloud_tags:
type: array
items:
type: string
cloud_type:
type: string
cpu_cores:
type: integer
format: int32
cpu_make:
type: string
cpu_model:
type: string
error_msg:
type: string
hostname:
type: string
ip_addresses:
type: array
items:
type: string
live_test_ran:
type: integer
format: int32
live_test_result:
type: integer
format: int32
mac_addresses:
type: array
items:
type: string
memory_total_bytes:
type: integer
format: int64
memory_total_gb:
type: number
format: double
os_name:
type: string
os_pretty_name:
type: string
request_ip:
type: string
spyder_tags:
type: object
additionalProperties:
type: string
src_uid:
type: string
uname:
type: string
description: Runtime details
securitySchemes:
apiToken:
type: http
scheme: bearer
bearerFormat: JWT
x-refined-from:
- spyderbat-openapi-original.json
- spyderbat-openapi.json