Request

Response

    Get All Knowledge Vaults
    GET

    vaults

    Retrieves the list of all Knowledge Vaults on the server without requiring sign-in.

    Resource Information

    Method and URI
    GET
    /AutodeskDM/Services/api/vault/v2/vaults
    Authentication Context
    No security required
    Required OAuth Scopes
    No scopes required
    Data Format
    JSON

    Request

    Query String Parameters

    limit
    int
    The maximum number of results to return per page. Defaults to 100.

    The hard upper bound is controlled by the Page size configuration setting, which an administrator can update through ADMS (Global Setting -> Page size configuration).

    cursorState
    string
    The cursor token used to fetch the next page of results. Pass the value returned in pagination.nextUrl from the previous response to continue paging.

    Response

    HTTP Status Code Summary

    200
    OK
    The list of Knowledge Vaults was successfully retrieved.
    403
    Forbidden
    The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again.

    Response

    Body Structure (200)

    Expand all
    pagination
    object
    Contains pagination metadata for navigating through large result sets.
    limit
    int
    The maximum number of results that can be returned in this response. The actual number of results may be fewer due to filtering, data availability, or other constraints. This reflects the limit value applied by the server, which may differ from the requested limit.
    totalResults
    int
    The total number of results available across all pages that match the query criteria, regardless of pagination limits.
    indexingStatus
    enum:string
    Indicates the current status of the indexing engine. This status helps users understand whether the indexing operation is complete or still in progress. This is particularly important for customers with large datasets, as indexing can take a considerable amount of time to complete. Possible values:
    • IndexingComplete - All properties and content have been indexed.
    • IndexingProperties - File properties are currently being indexed.
    • IndexingContent - File content is currently being indexed.
    • NA - Not applicable as data not retrieved from index.

    Note: When the status is either ‘IndexingProperties’ or ‘IndexingContent’, the search results are incomplete because the indexes are still being created. Complete search results will be available once fully indexed.

    nextUrl
    string
    The URL used to retrieve the next page of results. The URL includes an embedded cursor token for the subsequent call. When null or absent, this is the final page. Note that a page may be empty but still include a next page URL. Continue paging until this attribute is null or absent.
    results
    array: object
    An array of Knowledge Vaults.
    name
    string
    The name of the Knowledge Vault. This is also the name of the database.
    id
    string
    A unique identifier for the Knowledge Vault.
    url
    string
    The relative URL to access this object.

    Example

    This example illustrates how to get all vaults.

    Note: {VaultServerAddress} is used as a placeholder in the example(s) and could represent one of the following:

    • Vault Server IP address or hostname. Ex: http://10.41.110.49.
    • Vault Gateway URL if gateway is configured. Ex: https://test.vg.autodesk.com.

    Request

    curl -v '{VaultServerAddress}/AutodeskDM/Services/api/vault/v2/vaults' \
      -X 'GET' \
      -H 'Accept: application/json'
    

    Response

    {
      "pagination": {
        "limit": 1000,
        "totalResults": 2,
        "indexingStatus": "NA"
      },
      "results": [
        {
          "id": "101",
          "name": "PDMC-Sample",
          "url": "/AutodeskDM/Services/api/vault/v2/vaults/101"
        },
        {
          "id": "117",
          "name": "Vault",
          "url": "/AutodeskDM/Services/api/vault/v2/vaults/117"
        }
      ]
    }
    
    Show More