Sign in

v1

latestOpenAPI 3.0.1Vanta Terms of Service2026-07-26327517821.8 KB
Controls

Update a control's metadata

Update a control's metadata.

patch/controls/{controlId}

Path parameters

controlIdstring required

Request body

namestring

A new name for the control.

externalIdstring

The new external ID for the control.

descriptionstring

The new description for the control.

domain'ARTIFICIAL_&_AUTONOMOUS_TECHNOLOGY' | 'ASSET_MANAGEMENT' | 'BUSINESS_CONTINUITY_&_DISASTER_RECOVERY' | 'CAPACITY_&_PERFORMANCE_PLANNING' | 'CHANGE_MANAGEMENT' | 'CLOUD_SECURITY' | 'COMPLIANCE' | 'CONFIGURATION_MANAGEMENT' | 'CONTINUOUS_MONITORING' | 'CRYPTOGRAPHIC_PROTECTIONS' | 'DATA_CLASSIFICATION_&_HANDLING' | 'EMBEDDED_TECHNOLOGY' | 'ENDPOINT_SECURITY' | 'HUMAN_RESOURCES_SECURITY' | 'IDENTIFICATION_&_AUTHENTICATION' | 'INCIDENT_RESPONSE' | 'INFORMATION_ASSURANCE' | 'MAINTENANCE' | 'MOBILE_DEVICE_MANAGEMENT' | 'NETWORK SECURITY' | 'PHYSICAL_&_ENVIRONMENTAL_SECURITY' | 'PRIVACY' | 'PROJECT_&_RESOURCE MANAGEMENT' | 'RISK_MANAGEMENT' | 'SECURE_ENGINEERING_&_ARCHITECTURE' | 'SECURITY_AWARENESS_&_TRAINING' | 'SECURITY_OPERATIONS' | 'SECURITY_&_PRIVACY_GOVERNANCE' | 'TECHNOLOGY_DEVELOPMENT_&_ACQUISITION' | 'THIRD-PARTY_MANAGEMENT' | 'THREAT_MANAGEMENT' | 'VULNERABILITY_&_PATCH_MANAGEMENT' | 'WEB_SECURITY' | 'ADMINISTRATIVE' | 'PHYSICAL' | 'TECHNICAL' | 'BASIC' | 'DERIVED'
notestring

The new note for the control.

Response

Ok

idstring required

The control's unique ID.

externalIdstring nullable required

The control's external ID.

namestring required

The control's name.

descriptionstring required

The control's description.

source'Vanta' | 'Custom' required
domainsstring[] required

The security domains that the control belongs to.

rolestring nullable

The control's GDPR role, if the control is a GDPR control.

creationDatestring date-time nullable required

When the control was created. Returns null for Vanta library controls.

modificationDatestring date-time nullable required

When the control was last modified. Returns null for Vanta library controls.

numDocumentsPassingnumber double required

The number of passing documents that are linked to the control.

numDocumentsTotalnumber double required

The total number of documents that are linked to the control.

numTestsPassingnumber double required

The number of passing tests that are linked to the control.

numTestsTotalnumber double required

The total number of tests that are linked to the control.

status'NO_EVIDENCE_MAPPED' | 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' required
notestring nullable required

A user created note for the control.