Documentation Index
Fetch the complete documentation index at: https://vanta.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Before you begin
This guide is for Vanta admins managing data inside their own Vanta account. You’ll need:- A Manage Vanta API token.
- The token must have scope
vanta-api.all:read.
Building a remediation dashboard? Cache the test list (refreshed every 6–12 hours) and only re-fetch entities for tests whose
status is NEEDS_ATTENTION and whose lastTestRunDate has changed.List failing tests
Your terminal — call Response (truncated)Copy each
GET /v1/tests with statusFilter=NEEDS_ATTENTION. Add categoryFilter or frameworkFilter to narrow further.Terminal
id you want to inspect — you’ll send it as the path parameter in Step 2. The test ID is human-readable (e.g. inventory-list-owners), and you can also copy it from the URL on the Tests page.Got a 401?
Got a 401?
Token is expired (one-hour lifetime), missing, or lacks
vanta-api.all:read. Mint a fresh one — see Authentication → Tokens expire after one hour.What status filters are available?
What status filters are available?
OK, NEEDS_ATTENTION (failing), IN_PROGRESS, DEACTIVATED, INVALID, NOT_APPLICABLE. Most remediation tooling only cares about NEEDS_ATTENTION.Filter by framework or integration?
Filter by framework or integration?
Add
frameworkFilter=soc2 (or iso27001, hipaa, etc.) and/or integrationFilter=aws. Combine with categoryFilter to narrow to e.g. failing AWS infrastructure tests for SOC 2.Get the failing entities for a test
Your terminal — call Expected response (
GET /v1/tests/{testId}/entities with entityStatus=FAILING (the default). Each entity is the specific resource — an AWS account, S3 bucket, IAM user, etc. — that’s causing the test to fail.200):displayName is what you’ll surface in your UI (“S3 bucket my-data-bucket is failing”). id is the entity reference if you want to deactivate it later.Got a 404?
Got a 404?
The
testId is wrong. They’re case-sensitive and human-readable (e.g. inventory-list-owners, not Inventory list owners). Re-run Step 1 and copy the id exactly.No failing entities returned but the test is `NEEDS_ATTENTION`?
No failing entities returned but the test is `NEEDS_ATTENTION`?
Pagination —
pageSize defaults to 10. Pass pageSize=50 (max 100) and paginate with pageCursor until hasNextPage is false. Some tests have hundreds of failing entities.Want deactivated entities too?
Want deactivated entities too?
Pass
entityStatus=DEACTIVATED to see entities you’ve explicitly excluded from the test. These don’t count toward failure but are still tracked.Suppressing a known false positive? Use
POST /v1/tests/{testId}/entities/{entityId}/deactivate with a reason. Reactivate later with the matching /reactivate endpoint.Congratulations
You’ve gone from “which tests are failing?” to “which specific resources are causing each failure?” — exactly the slice you need to drive remediation, file tickets, or ping the right owner.Next steps
Add owners and descriptions
Many “needs attention” infrastructure tests are because resources are missing owners or descriptions.
Scope resources in or out
Mark resources
inScope: false to remove them from a test entirely.Try it in Postman
Import the collection and run the tests + entities calls against a sandbox in seconds.
Manage Vanta API reference
Browse every Manage Vanta endpoint — tests, entities, controls, documents, people.