Skip to content

Partial update of component attributes

PATCH
/components/{componentId}

Partial update — same behavior as PUT but only supplied fields are changed. Requires admin role on the parent project.

Authorizations

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)

Request Body

application/json
JSON
{
  
"component": {
  
  
"name": "Container SRG",
  
  
"prefix": "CNTR",
  
  
"version": 1,
  
  
"release": 1,
  
  
"title": "Container Platform Security Technical Implementation Guide",
  
  
"description": "STIG guidance for container orchestration platform deployments.",
  
  
"released": false,
  
  
"admin_name": "Jane Analyst",
  
  
"admin_email": "jane.analyst@example.com",
  
  
"advanced_fields": false,
  
  
"comment_phase": "open",
  
  
"closed_reason": "string",
  
  
"comment_period_starts_at": "2026-07-01T00:00:00Z",
  
  
"comment_period_ends_at": "2026-08-01T00:00:00Z",
  
  
"additional_questions_attributes": [
  
  
  
{
  
  
  
  
"id": 3,
  
  
  
  
"name": "Deployment environment",
  
  
  
  
"question_type": "dropdown",
  
  
  
  
"_destroy": false,
  
  
  
  
"options": [
  
  
  
  
  
[
  
  
  
  
  
  
"Cloud",
  
  
  
  
  
  
"On-prem"
  
  
  
  
  
]
  
  
  
  
]
  
  
  
}
  
  
],
  
  
"component_metadata_attributes": {
  
  
  
"data": {
  
  
  
  
"additionalProperties": "string"
  
  
  
}
  
  
}
  
}
}

Responses

Component updated

application/json
JSON
{
  
"toast": {
  
  
"title": "User updated.",
  
  
"message": [
  
  
  
[
  
  
  
  
"Successfully updated user."
  
  
  
]
  
  
],
  
  
"variant": "success"
  
}
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)