Overview
Add Vanta to any ModuleX agent or workflow. Query compliance posture and manage evidence in Vanta — frameworks, controls, automated tests, evidence documents, people, policies, vendors, monitored computers, vulnerabilities, and risk scenarios — via the Vanta v1 REST API (https://api.vanta.com/v1, or https://api.vanta-gov.com/v1 for the FedRAMP region).
Categories: Monitoring & Observability · Security · Compliance · GRC · Auth: Vanta OAuth Client Credentials · Actions: 29
Authentication
Vanta OAuth Client Credentials
Authenticate with a Vanta OAuth application’s Client ID + Client Secret (machine-to-machine client_credentials grant). The tool exchanges them for a short-lived access token on each request. Evidence uploads require the vanta-api.documents:upload scope.1
Step 1
Sign in to Vanta as an administrator
2
Step 2
Go to Settings -> Developer Console and create an API application
3
Step 3
Copy the generated Client ID and Client Secret (the Secret is shown only once)
4
Step 4
Grant the application the read scopes (and the documents:upload / write scopes if you need evidence upload or document submission)
5
Step 5
Choose your region: ‘us’ (api.vanta.com, default) or ‘gov’ (api.vanta-gov.com)
Required Credentials
| Field | Description | Required | Format |
|---|---|---|---|
| Client ID | Vanta OAuth application client ID | Yes | - |
| Client Secret | Vanta OAuth application client secret (shown only once at creation) | Yes | - |
| Region | Vanta API region: “us” (api.vanta.com, default) or “gov” (api.vanta-gov.com) | No | us |
Available Actions
list_frameworks — List the compliance frameworks (e.g., SOC 2, ISO 27001) available in a Vanta account with completion counts.
list_frameworks — List the compliance frameworks (e.g., SOC 2, ISO 27001) available in a Vanta account with completion counts.
Parameters
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"Framework": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"shorthand_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Shorthand Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"num_controls_completed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Controls Completed"
},
"num_controls_total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Controls Total"
},
"num_documents_passing": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Documents Passing"
},
"num_documents_total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Documents Total"
},
"num_tests_passing": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Tests Passing"
},
"num_tests_total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Tests Total"
}
},
"title": "Framework",
"type": "object"
},
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"frameworks": {
"items": {
"$ref": "#/$defs/Framework"
},
"title": "Frameworks",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListFrameworksOutput",
"type": "object"
}
get_framework — Get a Vanta compliance framework by ID, including its requirement categories and mapped controls.
get_framework — Get a Vanta compliance framework by ID, including its requirement categories and mapped controls.
Parameters
string
required
Unique ID of the framework (e.g., soc2).
Response
{
"$defs": {
"FrameworkDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"shorthand_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Shorthand Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"num_controls_completed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Controls Completed"
},
"num_controls_total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Controls Total"
},
"num_documents_passing": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Documents Passing"
},
"num_documents_total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Documents Total"
},
"num_tests_passing": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Tests Passing"
},
"num_tests_total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Tests Total"
},
"requirement_categories": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Requirement Categories",
"type": "array"
}
},
"title": "FrameworkDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"framework": {
"anyOf": [
{
"$ref": "#/$defs/FrameworkDetail"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetFrameworkOutput",
"type": "object"
}
list_framework_controls — List the controls that belong to a specific Vanta compliance framework.
list_framework_controls — List the controls that belong to a specific Vanta compliance framework.
Parameters
string
required
Unique ID of the framework (e.g., soc2).
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"Control": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"external_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "External Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source"
},
"domains": {
"items": {
"type": "string"
},
"title": "Domains",
"type": "array"
},
"owner": {
"anyOf": [
{
"$ref": "#/$defs/Owner"
},
{
"type": "null"
}
],
"default": null
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role"
},
"custom_fields": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Custom Fields",
"type": "array"
},
"creation_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Creation Date"
},
"modification_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Modification Date"
}
},
"title": "Control",
"type": "object"
},
"Owner": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
}
},
"title": "Owner",
"type": "object"
},
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"controls": {
"items": {
"$ref": "#/$defs/Control"
},
"title": "Controls",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListFrameworkControlsOutput",
"type": "object"
}
list_controls — List the security controls in a Vanta account, optionally filtered by framework.
list_controls — List the security controls in a Vanta account, optionally filtered by framework.
Parameters
string
Comma-separated framework IDs to filter controls by (e.g., soc2,iso27001).
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"Control": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"external_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "External Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source"
},
"domains": {
"items": {
"type": "string"
},
"title": "Domains",
"type": "array"
},
"owner": {
"anyOf": [
{
"$ref": "#/$defs/Owner"
},
{
"type": "null"
}
],
"default": null
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role"
},
"custom_fields": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Custom Fields",
"type": "array"
},
"creation_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Creation Date"
},
"modification_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Modification Date"
}
},
"title": "Control",
"type": "object"
},
"Owner": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
}
},
"title": "Owner",
"type": "object"
},
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"controls": {
"items": {
"$ref": "#/$defs/Control"
},
"title": "Controls",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListControlsOutput",
"type": "object"
}
get_control — Get a Vanta security control by ID, including its status and evidence pass/fail counts.
get_control — Get a Vanta security control by ID, including its status and evidence pass/fail counts.
Parameters
string
required
Unique ID of the control.
Response
{
"$defs": {
"ControlDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"external_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "External Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source"
},
"domains": {
"items": {
"type": "string"
},
"title": "Domains",
"type": "array"
},
"owner": {
"anyOf": [
{
"$ref": "#/$defs/Owner"
},
{
"type": "null"
}
],
"default": null
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role"
},
"custom_fields": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Custom Fields",
"type": "array"
},
"creation_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Creation Date"
},
"modification_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Modification Date"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Note"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"num_documents_passing": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Documents Passing"
},
"num_documents_total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Documents Total"
},
"num_tests_passing": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Tests Passing"
},
"num_tests_total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Tests Total"
}
},
"title": "ControlDetail",
"type": "object"
},
"Owner": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
}
},
"title": "Owner",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"control": {
"anyOf": [
{
"$ref": "#/$defs/ControlDetail"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetControlOutput",
"type": "object"
}
list_control_tests — List the automated tests mapped to a specific Vanta control.
list_control_tests — List the automated tests mapped to a specific Vanta control.
Parameters
string
required
Unique ID of the control.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"Owner": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
}
},
"title": "Owner",
"type": "object"
},
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"failure_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Failure Description"
},
"remediation_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Remediation Description"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"integrations": {
"items": {
"type": "string"
},
"title": "Integrations",
"type": "array"
},
"last_test_run_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Test Run Date"
},
"latest_flip_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Latest Flip Date"
},
"version": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Version"
},
"deactivated_status_info": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Deactivated Status Info"
},
"remediation_status_info": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Remediation Status Info"
},
"owner": {
"anyOf": [
{
"$ref": "#/$defs/Owner"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Test",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"tests": {
"items": {
"$ref": "#/$defs/Test"
},
"title": "Tests",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListControlTestsOutput",
"type": "object"
}
list_control_documents — List the evidence documents mapped to a specific Vanta control.
list_control_documents — List the evidence documents mapped to a specific Vanta control.
Parameters
string
required
Unique ID of the control.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"Document": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
},
"owner_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owner Id"
},
"is_sensitive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Sensitive"
},
"upload_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Upload Status"
},
"upload_status_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Upload Status Date"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
}
},
"title": "Document",
"type": "object"
},
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"documents": {
"items": {
"$ref": "#/$defs/Document"
},
"title": "Documents",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListControlDocumentsOutput",
"type": "object"
}
list_tests — List the automated compliance tests in a Vanta account, with filters for status, framework, integration, control, owner, and category.
list_tests — List the automated compliance tests in a Vanta account, with filters for status, framework, integration, control, owner, and category.
Parameters
string
Filter by test status: OK, DEACTIVATED, NEEDS_ATTENTION, IN_PROGRESS, INVALID, or NOT_APPLICABLE.
string
Filter by framework ID (e.g., soc2).
string
Filter by integration ID (e.g., aws).
string
Filter by control ID.
string
Filter by owner user ID.
string
Filter by test category (e.g., ACCOUNTS_ACCESS, COMPUTERS, INFRASTRUCTURE, POLICIES, VULNERABILITY_MANAGEMENT).
boolean
Filter by whether the test is in rollout.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"Owner": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
}
},
"title": "Owner",
"type": "object"
},
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"failure_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Failure Description"
},
"remediation_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Remediation Description"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"integrations": {
"items": {
"type": "string"
},
"title": "Integrations",
"type": "array"
},
"last_test_run_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Test Run Date"
},
"latest_flip_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Latest Flip Date"
},
"version": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Version"
},
"deactivated_status_info": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Deactivated Status Info"
},
"remediation_status_info": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Remediation Status Info"
},
"owner": {
"anyOf": [
{
"$ref": "#/$defs/Owner"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Test",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"tests": {
"items": {
"$ref": "#/$defs/Test"
},
"title": "Tests",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListTestsOutput",
"type": "object"
}
get_test — Get a Vanta automated compliance test by ID, including its status and remediation info.
get_test — Get a Vanta automated compliance test by ID, including its status and remediation info.
Parameters
string
required
Unique ID of the test (e.g., test-aws-cloudtrail-enabled).
Response
{
"$defs": {
"Owner": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
}
},
"title": "Owner",
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"failure_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Failure Description"
},
"remediation_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Remediation Description"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"integrations": {
"items": {
"type": "string"
},
"title": "Integrations",
"type": "array"
},
"last_test_run_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Test Run Date"
},
"latest_flip_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Latest Flip Date"
},
"version": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Version"
},
"deactivated_status_info": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Deactivated Status Info"
},
"remediation_status_info": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Remediation Status Info"
},
"owner": {
"anyOf": [
{
"$ref": "#/$defs/Owner"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Test",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"test": {
"anyOf": [
{
"$ref": "#/$defs/Test"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetTestOutput",
"type": "object"
}
list_test_entities — List the failing or deactivated resource entities for a specific Vanta test, useful for finding exactly which resources need remediation.
list_test_entities — List the failing or deactivated resource entities for a specific Vanta test, useful for finding exactly which resources need remediation.
Parameters
string
required
Unique ID of the test (e.g., test-aws-cloudtrail-enabled).
string
Filter entities by status: FAILING or DEACTIVATED.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
},
"TestEntity": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"entity_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Entity Status"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"response_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Response Type"
},
"deactivated_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Deactivated Reason"
},
"created_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created Date"
},
"last_updated_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Updated Date"
}
},
"title": "TestEntity",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"entities": {
"items": {
"$ref": "#/$defs/TestEntity"
},
"title": "Entities",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListTestEntitiesOutput",
"type": "object"
}
list_documents — List the evidence documents in a Vanta account, optionally filtered by framework or document status.
list_documents — List the evidence documents in a Vanta account, optionally filtered by framework or document status.
Parameters
string
Comma-separated framework IDs to filter documents by (e.g., soc2,iso27001).
string
Comma-separated document statuses to filter by: “Needs document”, “Needs update”, “Not relevant”, “OK”.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"Document": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
},
"owner_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owner Id"
},
"is_sensitive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Sensitive"
},
"upload_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Upload Status"
},
"upload_status_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Upload Status Date"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
}
},
"title": "Document",
"type": "object"
},
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"documents": {
"items": {
"$ref": "#/$defs/Document"
},
"title": "Documents",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListDocumentsOutput",
"type": "object"
}
get_document — Get a Vanta evidence document by ID, including its renewal schedule and deactivation status.
get_document — Get a Vanta evidence document by ID, including its renewal schedule and deactivation status.
Parameters
string
required
Unique ID of the document.
Response
{
"$defs": {
"DocumentDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
},
"owner_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owner Id"
},
"is_sensitive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Sensitive"
},
"upload_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Upload Status"
},
"upload_status_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Upload Status Date"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Note"
},
"next_renewal_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Renewal Date"
},
"renewal_cadence": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Renewal Cadence"
},
"reminder_window": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reminder Window"
},
"subscribers": {
"items": {
"type": "string"
},
"title": "Subscribers",
"type": "array"
},
"deactivated_status": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Deactivated Status"
}
},
"title": "DocumentDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"document": {
"anyOf": [
{
"$ref": "#/$defs/DocumentDetail"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetDocumentOutput",
"type": "object"
}
list_document_uploads — List the files uploaded to a specific Vanta evidence document.
list_document_uploads — List the files uploaded to a specific Vanta evidence document.
Parameters
string
required
Unique ID of the document.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
},
"UploadedFile": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"file_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "File Name"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"mime_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mime Type"
},
"uploaded_by": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Uploaded By"
},
"creation_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Creation Date"
},
"updated_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated Date"
},
"deletion_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Deletion Date"
},
"effective_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Effective Date"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
}
},
"title": "UploadedFile",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"uploads": {
"items": {
"$ref": "#/$defs/UploadedFile"
},
"title": "Uploads",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListDocumentUploadsOutput",
"type": "object"
}
upload_document_file — Upload an evidence file to a Vanta document. Requires credentials with the vanta-api.documents:upload scope.
upload_document_file — Upload an evidence file to a Vanta document. Requires credentials with the vanta-api.documents:upload scope.
Parameters
string
required
Unique ID of the document to attach the file to.
string
required
Base64-encoded content of the evidence file to upload.
string
required
File name for the upload (e.g., access-review.pdf).
string
MIME type of the file (e.g., application/pdf).
string
Description of the uploaded evidence (e.g., “Q3 access review evidence”).
string
ISO 8601 date indicating when the document is effective from.
Response
{
"$defs": {
"UploadedFile": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"file_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "File Name"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"mime_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mime Type"
},
"uploaded_by": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Uploaded By"
},
"creation_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Creation Date"
},
"updated_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated Date"
},
"deletion_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Deletion Date"
},
"effective_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Effective Date"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
}
},
"title": "UploadedFile",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"upload": {
"anyOf": [
{
"$ref": "#/$defs/UploadedFile"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "UploadDocumentFileOutput",
"type": "object"
}
download_document_file — Download a file previously uploaded to a Vanta evidence document (returned as base64 content).
download_document_file — Download a file previously uploaded to a Vanta evidence document (returned as base64 content).
Parameters
string
required
Unique ID of the document.
string
required
Unique ID of the uploaded file (from list_document_uploads).
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"mime_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mime Type"
},
"size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Size"
},
"data": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Data"
}
},
"required": [
"success"
],
"title": "DownloadDocumentFileOutput",
"type": "object"
}
submit_document — Submit a Vanta document collection for review so uploaded evidence becomes visible to auditors. Requires credentials with write access.
submit_document — Submit a Vanta document collection for review so uploaded evidence becomes visible to auditors. Requires credentials with write access.
Parameters
string
required
Unique ID of the document to submit.
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"document_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Document Id"
},
"submitted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Submitted"
}
},
"required": [
"success"
],
"title": "SubmitDocumentOutput",
"type": "object"
}
list_people — List the people tracked in a Vanta account with employment status, group membership, and security task completion.
list_people — List the people tracked in a Vanta account with employment status, group membership, and security task completion.
Parameters
string
Filter people by email address or name.
string
Filter by employment status: UPCOMING, CURRENT, ON_LEAVE, INACTIVE, or FORMER.
string
Comma-separated group IDs to filter people by.
string
Comma-separated task summary statuses: NONE, DUE_SOON, OVERDUE, COMPLETE, PAUSED, OFFBOARDING_DUE_SOON, OFFBOARDING_OVERDUE, OFFBOARDING_COMPLETE.
string
Comma-separated task types: COMPLETE_TRAININGS, ACCEPT_POLICIES, COMPLETE_CUSTOM_TASKS, COMPLETE_CUSTOM_OFFBOARDING_TASKS, INSTALL_DEVICE_MONITORING, COMPLETE_BACKGROUND_CHECKS.
string
Comma-separated task statuses: COMPLETE, DUE_SOON, OVERDUE, NONE.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
},
"Person": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"user_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "User Id"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
},
"name": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"employment": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Employment"
},
"leave_info": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Leave Info"
},
"group_ids": {
"items": {
"type": "string"
},
"title": "Group Ids",
"type": "array"
},
"tasks_summary": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Tasks Summary"
}
},
"title": "Person",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"people": {
"items": {
"$ref": "#/$defs/Person"
},
"title": "People",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListPeopleOutput",
"type": "object"
}
get_person — Get a person tracked in Vanta by ID, including employment, leave, and security task status.
get_person — Get a person tracked in Vanta by ID, including employment, leave, and security task status.
Parameters
string
required
Unique ID of the person.
Response
{
"$defs": {
"Person": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"user_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "User Id"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
},
"name": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"employment": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Employment"
},
"leave_info": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Leave Info"
},
"group_ids": {
"items": {
"type": "string"
},
"title": "Group Ids",
"type": "array"
},
"tasks_summary": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Tasks Summary"
}
},
"title": "Person",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"person": {
"anyOf": [
{
"$ref": "#/$defs/Person"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetPersonOutput",
"type": "object"
}
list_policies — List the security policies in a Vanta account with approval status and version info.
list_policies — List the security policies in a Vanta account with approval status and version info.
Parameters
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
},
"Policy": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"approved_at_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Approved At Date"
},
"latest_version_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Latest Version Status"
},
"latest_approved_version": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Latest Approved Version"
}
},
"title": "Policy",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"policies": {
"items": {
"$ref": "#/$defs/Policy"
},
"title": "Policies",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListPoliciesOutput",
"type": "object"
}
get_policy — Get a Vanta security policy by ID, including its approval status and latest approved version documents.
get_policy — Get a Vanta security policy by ID, including its approval status and latest approved version documents.
Parameters
string
required
Unique ID of the policy.
Response
{
"$defs": {
"Policy": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"approved_at_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Approved At Date"
},
"latest_version_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Latest Version Status"
},
"latest_approved_version": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Latest Approved Version"
}
},
"title": "Policy",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"policy": {
"anyOf": [
{
"$ref": "#/$defs/Policy"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetPolicyOutput",
"type": "object"
}
list_vendors — List the vendors tracked in a Vanta account with risk levels, contract dates, and security review schedules.
list_vendors — List the vendors tracked in a Vanta account with risk levels, contract dates, and security review schedules.
Parameters
string
Filter vendors by name.
string
Comma-separated vendor statuses: MANAGED, ARCHIVED, IN_PROCUREMENT.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
},
"Vendor": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"website_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Website Url"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
},
"services_provided": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Services Provided"
},
"additional_notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Additional Notes"
},
"account_manager_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Manager Name"
},
"account_manager_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Manager Email"
},
"security_owner_user_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Security Owner User Id"
},
"business_owner_user_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Business Owner User Id"
},
"inherent_risk_level": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Inherent Risk Level"
},
"residual_risk_level": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Residual Risk Level"
},
"is_risk_auto_scored": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Risk Auto Scored"
},
"is_visible_to_auditors": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Visible To Auditors"
},
"risk_attribute_ids": {
"items": {
"type": "string"
},
"title": "Risk Attribute Ids",
"type": "array"
},
"vendor_headquarters": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Vendor Headquarters"
},
"contract_start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Contract Start Date"
},
"contract_renewal_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Contract Renewal Date"
},
"contract_termination_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Contract Termination Date"
},
"contract_amount": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Contract Amount"
},
"next_security_review_due_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Security Review Due Date"
},
"last_security_review_completion_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Security Review Completion Date"
},
"auth_details": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Auth Details"
},
"custom_fields": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Custom Fields",
"type": "array"
},
"latest_decision": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Latest Decision"
},
"linked_task_tracker_task_procurement_request": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Linked Task Tracker Task Procurement Request"
}
},
"title": "Vendor",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"vendors": {
"items": {
"$ref": "#/$defs/Vendor"
},
"title": "Vendors",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListVendorsOutput",
"type": "object"
}
get_vendor — Get a Vanta vendor by ID, including risk levels, contract details, and authentication info.
get_vendor — Get a Vanta vendor by ID, including risk levels, contract details, and authentication info.
Parameters
string
required
Unique ID of the vendor.
Response
{
"$defs": {
"Vendor": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"website_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Website Url"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
},
"services_provided": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Services Provided"
},
"additional_notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Additional Notes"
},
"account_manager_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Manager Name"
},
"account_manager_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Manager Email"
},
"security_owner_user_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Security Owner User Id"
},
"business_owner_user_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Business Owner User Id"
},
"inherent_risk_level": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Inherent Risk Level"
},
"residual_risk_level": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Residual Risk Level"
},
"is_risk_auto_scored": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Risk Auto Scored"
},
"is_visible_to_auditors": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Visible To Auditors"
},
"risk_attribute_ids": {
"items": {
"type": "string"
},
"title": "Risk Attribute Ids",
"type": "array"
},
"vendor_headquarters": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Vendor Headquarters"
},
"contract_start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Contract Start Date"
},
"contract_renewal_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Contract Renewal Date"
},
"contract_termination_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Contract Termination Date"
},
"contract_amount": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Contract Amount"
},
"next_security_review_due_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Security Review Due Date"
},
"last_security_review_completion_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Security Review Completion Date"
},
"auth_details": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Auth Details"
},
"custom_fields": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Custom Fields",
"type": "array"
},
"latest_decision": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Latest Decision"
},
"linked_task_tracker_task_procurement_request": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Linked Task Tracker Task Procurement Request"
}
},
"title": "Vendor",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"vendor": {
"anyOf": [
{
"$ref": "#/$defs/Vendor"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetVendorOutput",
"type": "object"
}
list_monitored_computers — List the monitored computers in a Vanta account with screenlock, disk encryption, password manager, and antivirus check outcomes.
list_monitored_computers — List the monitored computers in a Vanta account with screenlock, disk encryption, password manager, and antivirus check outcomes.
Parameters
string
Comma-separated compliance issues: PWM_NOT_INSTALLED, HD_NOT_ENCRYPTED, AV_NOT_INSTALLED, SCREENLOCK_NOT_CONFIGURED, LAST_CHECK_OVER_14_DAYS.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"MonitoredComputer": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"integration_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Integration Id"
},
"last_check_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Check Date"
},
"screenlock": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Screenlock"
},
"disk_encryption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Disk Encryption"
},
"password_manager": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Password Manager"
},
"antivirus_installation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Antivirus Installation"
},
"operating_system": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Operating System"
},
"owner": {
"anyOf": [
{
"$ref": "#/$defs/Owner"
},
{
"type": "null"
}
],
"default": null
},
"serial_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serial Number"
},
"udid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Udid"
}
},
"title": "MonitoredComputer",
"type": "object"
},
"Owner": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
}
},
"title": "Owner",
"type": "object"
},
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"computers": {
"items": {
"$ref": "#/$defs/MonitoredComputer"
},
"title": "Computers",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListMonitoredComputersOutput",
"type": "object"
}
list_vulnerabilities — List the vulnerabilities detected across a Vanta account with filters for severity, fixability, SLA deadlines, package, and integration.
list_vulnerabilities — List the vulnerabilities detected across a Vanta account with filters for severity, fixability, SLA deadlines, package, and integration.
Parameters
string
Search query for vulnerabilities.
string
Filter by severity: LOW, MEDIUM, HIGH, or CRITICAL.
boolean
Filter by whether a fix is available.
boolean
Filter by whether vulnerability monitoring is deactivated.
boolean
Include vulnerabilities that have no SLA deadline.
string
Filter by the affected package identifier.
string
Filter by external vulnerability ID (e.g., a CVE identifier).
string
Filter by the integration that detected the vulnerability.
string
Filter by the vulnerable asset ID.
string
Only include vulnerabilities with an SLA deadline after this ISO 8601 date.
string
Only include vulnerabilities with an SLA deadline before this ISO 8601 date.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
},
"Vulnerability": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"severity": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Severity"
},
"vulnerability_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Vulnerability Type"
},
"integration_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Integration Id"
},
"target_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target Id"
},
"package_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Package Identifier"
},
"cvss_severity_score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Cvss Severity Score"
},
"scanner_score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Scanner Score"
},
"is_fixable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Fixable"
},
"fixed_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Fixed Version"
},
"remediate_by_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Remediate By Date"
},
"first_detected_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "First Detected Date"
},
"source_detected_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source Detected Date"
},
"last_detected_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Detected Date"
},
"scan_source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Scan Source"
},
"external_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "External Url"
},
"related_vulns": {
"items": {
"type": "string"
},
"title": "Related Vulns",
"type": "array"
},
"related_urls": {
"items": {
"type": "string"
},
"title": "Related Urls",
"type": "array"
},
"deactivate_metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Deactivate Metadata"
}
},
"title": "Vulnerability",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"vulnerabilities": {
"items": {
"$ref": "#/$defs/Vulnerability"
},
"title": "Vulnerabilities",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListVulnerabilitiesOutput",
"type": "object"
}
list_vulnerability_remediations — List remediated vulnerabilities in a Vanta account with detection, SLA deadline, and remediation dates.
list_vulnerability_remediations — List remediated vulnerabilities in a Vanta account with detection, SLA deadline, and remediation dates.
Parameters
string
Filter by the integration that detected the vulnerability.
string
Filter by severity: LOW, MEDIUM, HIGH, or CRITICAL.
boolean
Filter by whether the vulnerability was remediated before its SLA deadline.
string
Only include remediations completed after this ISO 8601 date.
string
Only include remediations completed before this ISO 8601 date.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
},
"VulnerabilityRemediation": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"vulnerability_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Vulnerability Id"
},
"vulnerable_asset_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Vulnerable Asset Id"
},
"severity": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Severity"
},
"detected_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Detected Date"
},
"sla_deadline_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sla Deadline Date"
},
"remediation_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Remediation Date"
}
},
"title": "VulnerabilityRemediation",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"remediations": {
"items": {
"$ref": "#/$defs/VulnerabilityRemediation"
},
"title": "Remediations",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListVulnerabilityRemediationsOutput",
"type": "object"
}
list_vulnerable_assets — List the assets associated with vulnerabilities in a Vanta account (servers, repositories, workstations, and more).
list_vulnerable_assets — List the assets associated with vulnerabilities in a Vanta account (servers, repositories, workstations, and more).
Parameters
string
Search query for vulnerable assets.
string
Filter by the integration scanning the asset.
string
Filter by asset type: SERVER, SERVERLESS_FUNCTION, CONTAINER, CONTAINER_REPOSITORY, CONTAINER_REPOSITORY_IMAGE, CODE_REPOSITORY, MANIFEST_FILE, WORKSTATION, or OTHER.
string
Filter by the external account ID the asset belongs to.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
},
"VulnerableAsset": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"asset_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Asset Type"
},
"has_been_scanned": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Been Scanned"
},
"image_scan_tag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Image Scan Tag"
},
"scanners": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Scanners",
"type": "array"
}
},
"title": "VulnerableAsset",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"assets": {
"items": {
"$ref": "#/$defs/VulnerableAsset"
},
"title": "Assets",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListVulnerableAssetsOutput",
"type": "object"
}
get_vulnerable_asset — Get a vulnerable asset in Vanta by ID, including the scanners reporting it and per-scanner asset details.
get_vulnerable_asset — Get a vulnerable asset in Vanta by ID, including the scanners reporting it and per-scanner asset details.
Parameters
string
required
Unique ID of the vulnerable asset.
Response
{
"$defs": {
"VulnerableAsset": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"asset_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Asset Type"
},
"has_been_scanned": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Been Scanned"
},
"image_scan_tag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Image Scan Tag"
},
"scanners": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Scanners",
"type": "array"
}
},
"title": "VulnerableAsset",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"asset": {
"anyOf": [
{
"$ref": "#/$defs/VulnerableAsset"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetVulnerableAssetOutput",
"type": "object"
}
list_risk_scenarios — List the risk scenarios in a Vanta risk register with likelihood/impact scores, treatment decisions, and review status.
list_risk_scenarios — List the risk scenarios in a Vanta risk register with likelihood/impact scores, treatment decisions, and review status.
Parameters
string
Search string to filter risk scenarios.
boolean
Include ignored risk scenarios.
string
Filter by scenario type: “Risk Scenario” or “Enterprise Risk”.
string
Comma-separated owner emails to filter by.
string
Comma-separated risk categories to filter by.
string
Comma-separated CIA categories: Confidentiality, Integrity, Availability.
string
Comma-separated treatments: Mitigate, Transfer, Avoid, Accept.
string
Comma-separated inherent score groups: “Very low”, Low, Med, High, Critical.
string
Comma-separated residual score groups: “Very low”, Low, Med, High, Critical.
string
Comma-separated review statuses: APPROVED, DRAFT, NOT_REVIEWED, AWAITING_SUBMISSION, PENDING_APPROVAL, REQUESTED_CHANGES.
string
Field to order results by: description or createdAt.
integer
Maximum number of items per page (1-100, default 10).
string
Pagination cursor: pass the end_cursor from a previous response to fetch the next page.
integer
Maximum number of pages to fetch when auto-paginating (default 1). (Default:
1)Response
{
"$defs": {
"PageInfo": {
"additionalProperties": false,
"description": "Cursor pagination info returned by every list endpoint.",
"properties": {
"start_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Cursor"
},
"end_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Cursor"
},
"has_next_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Next Page"
},
"has_previous_page": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Previous Page"
}
},
"title": "PageInfo",
"type": "object"
},
"RiskScenario": {
"additionalProperties": false,
"properties": {
"risk_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Risk Id"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"likelihood": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Likelihood"
},
"impact": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Impact"
},
"residual_likelihood": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Residual Likelihood"
},
"residual_impact": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Residual Impact"
},
"categories": {
"items": {
"type": "string"
},
"title": "Categories",
"type": "array"
},
"cia_categories": {
"items": {
"type": "string"
},
"title": "Cia Categories",
"type": "array"
},
"treatment": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Treatment"
},
"owner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owner"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Note"
},
"risk_register": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Risk Register"
},
"custom_fields": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Custom Fields",
"type": "array"
},
"is_archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Archived"
},
"review_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Review Status"
},
"required_approvers": {
"items": {
"type": "string"
},
"title": "Required Approvers",
"type": "array"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"identification_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Identification Date"
}
},
"title": "RiskScenario",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"risk_scenarios": {
"items": {
"$ref": "#/$defs/RiskScenario"
},
"title": "Risk Scenarios",
"type": "array"
},
"page_info": {
"anyOf": [
{
"$ref": "#/$defs/PageInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ListRiskScenariosOutput",
"type": "object"
}
get_risk_scenario — Get a Vanta risk scenario by ID, including its scores, treatment decision, and review status.
get_risk_scenario — Get a Vanta risk scenario by ID, including its scores, treatment decision, and review status.
Parameters
string
required
Unique ID of the risk scenario.
Response
{
"$defs": {
"RiskScenario": {
"additionalProperties": false,
"properties": {
"risk_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Risk Id"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"likelihood": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Likelihood"
},
"impact": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Impact"
},
"residual_likelihood": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Residual Likelihood"
},
"residual_impact": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Residual Impact"
},
"categories": {
"items": {
"type": "string"
},
"title": "Categories",
"type": "array"
},
"cia_categories": {
"items": {
"type": "string"
},
"title": "Cia Categories",
"type": "array"
},
"treatment": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Treatment"
},
"owner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owner"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Note"
},
"risk_register": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Risk Register"
},
"custom_fields": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Custom Fields",
"type": "array"
},
"is_archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Archived"
},
"review_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Review Status"
},
"required_approvers": {
"items": {
"type": "string"
},
"title": "Required Approvers",
"type": "array"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"identification_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Identification Date"
}
},
"title": "RiskScenario",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"risk_scenario": {
"anyOf": [
{
"$ref": "#/$defs/RiskScenario"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetRiskScenarioOutput",
"type": "object"
}
Limits & Quotas
- The Manage Vanta API is rate-limited to roughly 50 requests/minute; consult your Vanta plan for exact limits.
- Vanta keeps only one access token active per application — the tool exchanges a fresh token per call.
- List actions auto-paginate up to
max_pages(default 1); raise it to gather more pages in one call. - Error model: non-2xx responses (including auth failures) are caught and
returned as
success=False+errorrather than raising.