Environment

Synchronize a child environment with its parent

This synchronizes the code and/or data of an environment with that of its parent, then redeploys the environment. Synchronization is only possible if a branch has no unmerged commits and it can be fast-forwarded.

If data synchronization is specified, the data in the environment will be overwritten with that of its parent.

post/projects/{projectId}/environments/{environmentId}/synchronize

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/synchronize/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdstring required

environmentIdstring required

Request body

synchronize_codeboolean required

Synchronize code?

rebaseboolean required

Synchronize code by rebasing instead of merging

synchronize_databoolean required

Synchronize data?

synchronize_resourcesboolean required

Synchronize resources?

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.