Download project backup

post/v2/projects/{ref}/backups/download

OAuth scopes

database:write

The fine-grained token must include the following permissions to access this endpoint:

backups_write

Path parameters

ref
Required
string
Project ref

Body

data
Required
object

Response codes

Response (201)

1
{
2
  "data": {
3
    "type": "project_backup_file_url",
4
    "id": 42,
5
    "attributes": {
6
      "file_url": "lorem"
7
    }
8
  }
9
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "data": {
5
      "type": "object",
6
      "properties": {
7
        "type": {
8
          "type": "string",
9
          "description": "Resource type.",
10
          "enum": [
11
            "project_backup_file_url"
12
          ]
13
        },
14
        "id": {
15
          "type": "number"
16
        },
17
        "attributes": {
18
          "type": "object",
19
          "properties": {
20
            "file_url": {
21
              "type": "string"
22
            }
23
          },
24
          "required": [
25
            "file_url"
26
          ]
27
        }
28
      },
29
      "required": [
30
        "type",
31
        "id",
32
        "attributes"
33
      ]
34
    }
35
  },
36
  "required": [
37
    "data"
38
  ]
39
}