Perform a sync operation from a source environment to the current environment

POST

/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/sync/{type}

curl --request POST \
  --url https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/test-env/sync/database \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sourceEnvironment": "example" }'

• QuantCDN Public Cloud
• QuantGov Cloud

Authorizations

• BearerAuth

Parameters

Path Parameters

organisation

required

string

The organisation ID

Example

test-org

application

required

string

The application ID

Example

test-app

environment

required

string

The environment ID

Example

test-env

type

required

string

Allowed values: database filesystem

The sync type

Request Body^required

Media typeapplication/json

object

sourceEnvironment

string

Example^generated

{
  "sourceEnvironment": "example"
}

Responses

200

The sync operation details

Media typeapplication/json

object

syncId

string

syncType

string

sourceEnvironment

string

targetEnvironment

string

status

string

createdAt

string

completedAt

string

Example^generated

{
  "syncId": "example",
  "syncType": "example",
  "sourceEnvironment": "example",
  "targetEnvironment": "example",
  "status": "example",
  "createdAt": "example",
  "completedAt": "example"
}