REST API v1

ShieldGraph API Reference

Integrate vulnerability scanning, asset management, and attack graph visualization into your security workflows with our REST API.

Base URLhttps://api.shieldgraph.com/api/v1

Authentication

All endpoints (except /register and /login) require a Bearer token in the Authorization header.

Authorization: Bearer sg_live_xxxxxxxxxxxxxxxxxxxx

POST/registerCreate a new user account and organization

POST/loginAuthenticate and receive a JWT access token

GET/assetsList all assets in your organization

POST/assetsRegister a new asset for scanning

GET/assets/:idGet details for a specific asset

PUT/assets/:idUpdate an existing asset configuration

DELETE/assets/:idRemove an asset from your organization

GET/scansList all scans with status and results summary

POST/scansTrigger a new vulnerability scan

GET/scans/:idGet details and progress for a specific scan

GET/findingsList all vulnerability findings with filtering

GET/findings/:idGet detailed information for a specific finding

PUT/findings/:idUpdate finding status (e.g., mark as resolved)

GET/graph/topologyGet the full infrastructure topology graph

GET/graph/attack-pathsGet computed attack paths and risk scores

Response Codes

200OKRequest succeeded

201CreatedResource created successfully

400Bad RequestInvalid request parameters

401UnauthorizedMissing or invalid authentication

403ForbiddenInsufficient permissions

404Not FoundResource does not exist

429Rate LimitedToo many requests, retry after cooldown

500Server ErrorInternal server error

Rate Limiting

Starter

Rate Limit

100 req/min

Burst

20 req/sec

Professional

Rate Limit

500 req/min

Burst

50 req/sec

Enterprise

Rate Limit

Unlimited

Burst

Custom

ShieldGraph API Reference

Authentication

Authentication

Assets

Scans

Findings

Graph

Response Codes

Rate Limiting

Starter

Professional

Enterprise