deployments

List Deployment Files

Changed on

Allows to retrieve the file structure of the source code of a deployment by supplying the deployment unique identifier. If the deployment was created with the Vercel CLI or the API directly with the files key, it will have a file tree that can be retrievable.

get/v6/deployments/{id}/files

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v6/deployments/{id}/files
  • Auth: HTTP bearer

Path parameters

idstring required

The unique deployment identifier

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

Retrieved the file tree successfully

childrenFileTree[] circular
contentTypestring

The content-type of the file (only valid for the file type)

modenumber required

The file "mode" indicating file type and permissions.

namestring required

The name of the file tree entry

type'directory' | 'file' | 'invalid' | 'lambda' | 'middleware' | 'symlink' required

String indicating the type of file tree entry.

uidstring

The unique identifier of the file (only valid for the file type)

Example response

[
  {
    "contentType": "application/json",
    "name": "my-file.json",
    "type": "file",
    "uid": "2d4aad419917f15b1146e9e03ddc9bb31747e4d0"
  }
]

Changes