Request

Response

    Generate File Version Download URL
    GET

    vaults/{vaultId}/file-versions/{id}/signedurl

    Generates a time-limited, cryptographically signed URL that provides secure access to download the file resource for the specified file version ID.

    Resource Information

    Method and URI
    GET
    /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/file-versions/{id}/signedurl
    Authentication Context
    User context required
    Required OAuth Scopes
    No scopes required
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow or a Secure Service Account (SSA) flow.

    The SSA flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context.

    * Required

    Request

    URI Parameters

    vaultId
    string
    The unique identifier of a Knowledge Vault.
    id
    string
    The unique identifier of a file version.

    Request

    Query String Parameters

    wmSrcItemVerId
    string
    The item version ID to use as the watermark source. Supply this when the current file is a DWF associated with an Item and you want to download its watermarked version.
    wmSrcFileVerId
    string
    The file version ID (or CAD file version ID) to use as the watermark source. Supply this when the current file is a DWF associated with an Item, either directly or as a CAD file’s visualization attachment, and you want to download its watermarked version.
    contentDisposition
    string
    The Content-Disposition header value to apply to the response.
    • inline: The file is displayed inside the web page.
    • attachment (or null): The file is saved as a download.

    Any other value is passed through as-is, but the resulting browser behavior is not guaranteed.

    expirationTime
    int
    The duration in seconds for which the signed URL remains valid. The maximum allowed value is 180 seconds. Example: expirationTime=120.

    Response

    HTTP Status Code Summary

    200
    OK
    The signed download URL was successfully retrieved.
    400
    Bad Request
    The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request.
    401
    Unauthorized
    The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again.
    403
    Forbidden
    The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again.
    404
    Not Found
    The requested resource was not found.

    Response

    Body Structure (200)

    id
    string
    url
    string

    Example

    This example illustrates how to generate a signed download URL for a file version.

    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/9/file-versions/43/signedurl?contentDisposition=attachment&expirationTime=120' \
      -X 'GET' \
      -H 'Accept: application/json'\
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
    

    Response

    {
      "id": "43",
      "url": "https://download.example.com/vault/v2/file-versions/43/content?sig=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9&expires=1711100000"
    }