Skip to content

Project detail with component list and stats

GET
/projects/{projectId}

Returns full project details including components, membership count, comment counts, and project metadata. Requires membership in the project or admin role.

Authorizations

cookieAuth
Type
API Key (cookie: _vulcan_session)
or
tokenAuth

Personal access token authentication. Send via Authorization header: Authorization: Token vulcan_xxx. Tokens are SHA-256 hashed server-side (never stored in plaintext). Scopes: read (GET), write (mutations), admin (everything). Create tokens via Settings → API Tokens in the web UI.

Type
HTTP (token)

Responses

Project detail with components

application/json
JSON
{
  
"id": 1,
  
"name": "Photon 3",
  
"memberships_count": 16,
  
"pending_comment_count": 1,
  
"components": [
  
  
{
  
  
  
"id": 1,
  
  
  
"name": "Photon OS 3",
  
  
  
"prefix": "PHOS-03"
  
  
}
  
]
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)