Add-ons1

Alerts2

API Tokens4

Autoscaling3

Cert Management8

Connections3

Deployment2

Deployment Target5

Discounts3

Domain Management10

Environment19

Environment Activity3

Environment Backups5

Environment Type2

Environment Variables5

Grants1

Invoices2

MFA8

Orders4

Organization Invitations3

Organization Management5

Organization Members5

Organization Projects6

Organizations6

PhoneNumber2

Profiles4

Project5

Project Activity3

Project Invitations3

Project Settings2

Project Variables5

Records2

References5

Regions2

Repository5

Routing2

Runtime Operations1

Source Operations2

SSH Keys3

Subscriptions13

Support4

System Information2

Team Access8

Teams10

Third-Party Integrations5

User Access10

User Profiles7

Users10

Vouchers2

Environment Backups

Restore an environment snapshot

Restore a specific backup from an environment using the id of the entry retrieved by the Get backups list endpoint.

post/projects/{projectId}/environments/{environmentId}/backups/{backupId}/restore

Request

Base URL
https://api.upsun.com
Auth
OAuth 2
Authorization codehttps://auth.api.platform.sh/oauth2/authorize
Token URLhttps://auth.api.platform.sh/oauth2/token
TypeScript
https://skmtc.dev/upsun/apis/upsun-com-rest-api/docs/projects/:projectId/environments/:environmentId/backups/:backupId/restore/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdstring required

environmentIdstring required

backupIdstring required

Request body

environment_namestring nullable required

branch_fromstring nullable required

restore_codeboolean required

Whether we should restore the code or only the data

restore_resourcesboolean required

Whether we should restore resources configuration from the backup

Response

statusstring required

The status text of the response

codeinteger required

The status code of the response

Changes

No recorded changes to this operation across all 1 revision of this API.