List documents for a deployment policy (Beta)

GET

/v2/deploymentPolicies/:deploymentPolicyId/files

GET

/v2/deploymentPolicies/:deploymentPolicyId/files

$ curl https://api.sigmacomputing.com/v2/deploymentPolicies/deploymentPolicyId/files \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entries": [
3     {
4       "inodeId": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f1a9d8c",
5       "inode": {
6         "name": "Q2 Sales Dashboard",
7         "type": "workbook",
8         "workbookId": "wb-9f8e7d6c5b4a3f2e1d0c"
9       },
10       "deploymentPolicyId": "dp-1234567890abcdef"
11     },
12     {
13       "inodeId": "b4e2d3c1-5a6f-7b8c-9d0e-1f2a3b4c5d6e",
14       "inode": {
15         "dataModelId": "dm-0a1b2c3d4e5f67890abc",
16         "name": "Customer Data Model",
17         "type": "dataModel"
18       },
19       "deploymentPolicyId": "dp-1234567890abcdef"
20     },
21     {
22       "inodeId": "c5d6e7f8-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
23       "inode": null,
24       "deploymentPolicyId": "dp-1234567890abcdef"
25     }
26   ],
27   "nextPageToken": "eyJwYWdlIjoxfQ=="
28 }

List documents for a deployment policy

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Usage notes

Retrieve the deploymentPolicyId from the /v2/deploymentPolicies endpoint.
If the user associated with the API key does not have access to the document, the inode field is null.

Usage scenarios

Review and audit documents deployed to specific tenant organizations.

List documents for a deployment policy **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint. - If the user associated with the API key does not have access to the document, the `inode` field is `null`. ### Usage scenarios - Review and audit documents deployed to specific tenant organizations.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

deploymentPolicyIdstringRequired

Query parameters

pageTokenstringOptional

pageSizeintegerOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

nextPageTokenstring

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.