Skip to content

Bra1n API

Full CRUD for all 7 asset types, plus search, history, links, and credential vault management.

Required scope: brain:read or brain:write

Endpoints

Core CRUD (per type)

GET/api/brain/:typeList assets
POST/api/brain/:typeCreate asset
GET/api/brain/:type/:idGet asset
PUT/api/brain/:type/:idUpdate asset
DELETE/api/brain/:type/:idDelete asset

Types: sites, locations, endpoints, assets, applications, subnets, credentials

Search & Aggregation

GET/api/brain/statsAsset counts by type
GET/api/brain/recentRecently updated items
GET/api/brain/search?q=...Full-text search
GET/api/brain/resolve/:sidResolve short ID

Relations

GET/api/brain/endpoints/:id/monitorsLinked monitors
GET/api/brain/applications/:id/monitorsLinked monitors
GET/api/brain/subnets/:id/v1sion-sessionsV1sion sessions
GET/api/brain/history/:type/:idChange history
GET/api/brain/links/:type/:idEntity links
POST/api/brain/linksCreate link
DELETE/api/brain/links/:idDelete link

Credential Vault

GET/api/brain/vault/statusVault lock status
POST/api/brain/vault/setupInitial setup (admin)
POST/api/brain/vault/unlockUnlock vault (admin)
POST/api/brain/vault/lockLock vault (admin)

Credentials

GET/api/brain/credentialsList (secrets redacted)
POST/api/brain/credentialsCreate (admin)
GET/api/brain/credentials/:idGet credential
PUT/api/brain/credentials/:idUpdate (admin)
DELETE/api/brain/credentials/:idDelete (admin)
GET/api/brain/credentials/:id/scanScan results

Asset Stats

GET/api/brain/stats
json
{
  "sites": 5, "locations": 12, "endpoints": 48,
  "assets": 23, "applications": 8, "subnets": 6, "credentials": 3
}
GET/api/brain/search?q=router

Full-text search across all asset types. Minimum 2 characters. Returns up to 30 results.

Resolve Short ID

GET/api/brain/resolve/:sid

Resolves a short ID (e.g., EP-001, ST-003) to its asset type and full data.

Credentials Security

  • Secrets are redacted in list/get responses
  • Write operations require admin role
  • Write-only fields: community, password, snmpv3_priv_key
  • Omitting a secret field in updates preserves the existing value

Released under the MIT License.