List Deployment Files | Edgenivo REST API

APIs & SDKs

List Deployment Files

GET/__remote/api.vercel.com/v6/deployments/{id}/files

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 Edgenivo CLI or the API directly with the files key, it will have a file tree that can be retrievable.

/__remote/api.vercel.com/v6/deployments/{id}/files

const response = await fetch('/__remote/api.vercel.com/v6/deployments/id/files?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

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

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idstringRequired

The unique deployment identifier

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Retrieved the file tree successfully

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404File tree not found Deployment not found

410Error

/__remote/api.vercel.com/v6/deployments/{id}/files

const response = await fetch('/__remote/api.vercel.com/v6/deployments/id/files?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

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

OpenAPI Specification