Get test entities by test ID

Gets a list of tested items (entities) for a test by test ID. An entity is a tested item that can have its own outcome. For example, for a test that makes sure that all S3 buckets are versioned, an individual S3 bucket would be an entity.

GET /tests/{testId}/entities

Get test entities by test ID

cURL

curl --request GET \
  --url https://api.vanta.com/v1/tests/{testId}/entities \
  --header 'Authorization: Bearer <token>'

200

{
  "results": {
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "endCursor": "YXJyYXljb25uZWN0aW9uOjA=",
      "startCursor": "YXJyYXljb25uZWN0aW9uOjE="
    },
    "data": [
      {
        "id": "65fc81a3359c8508c9af880f",
        "entityStatus": "FAILING",
        "displayName": "account-123456789012",
        "responseType": "AWS account",
        "deactivatedReason": null,
        "lastUpdatedDate": "2024-06-18T20:17:38.463Z",
        "createdDate": "2024-06-18T20:17:38.463Z"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

testId · string · required

Query Parameters

entityStatus · enum<string>

The status of the test entities. Defaults to FAILING. Possible values: FAILING, DEACTIVATED

Available options: FAILING, DEACTIVATED

pageSize · integer<int32> · default: 10

Controls the maximum number of items returned in one response from the API.

Required range: 1 <= x <= 100

pageCursor · string

A marker or pointer, telling the API where to start fetching items for the subsequent page in a paginated dataset. Note that the requested page will not include the item that corresponds to this cursor but will start from the one immediately after this cursor.

Response

200 - application/json

Ok

results · object · required

Show child attributes