Create a backup of the postgres service root branch
POSThttps://api.instacloud.com/projects/{projectId}/backups
Token scope: account · org · project — read-only tokens refused (not a GET).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
name | query | string | no | snapshot name |
type | query | "manual" | no | manual backup tag; createBackup always creates manual backups |
expiresAt | query | string | no | RFC3339 expiry; omitted = keep until deleted |
timestamp | query | string | no | RFC3339 past point within the history window; omitted = now |
group | query | string | no | postgres service name (default: the sole postgres service) |
projectId | path | string | yes |
Responses
200
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
id | string | no | |
name | string | no | |
type | string | no | provider backup type, such as full or incr |
tags | object | no | provider backup tags; tags.type=manual marks user-created manual backups |
createdAt | string | no | |
timestamp | string | no | |
sizeBytes | number | no |
202
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
status | string | yes | |
approvalId | string | yes | |
action | string | yes | |
actions | string[] | yes | |
message | string | yes | |
url | string | yes |
400
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes |
403
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes |
404
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes |
409
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes |
502
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes |