Create a database export

You can create a database export from a sandbox environment to the project's asset library. Note that the same validation rules from the details page in Microsoft Dynamics Lifecycle Services (LCS) apply to the application programming interface (API).

Permissions

One of the following permissions is required to call this API. For more information about permissions and how to select them, see Authentication.

Permission type Permissions (from least privileged to most privileged)
Delegated (work or school account) user_impersonation

HTTP request

POST /databasemovement/v1/export/project/{projectId}/environment/{environmentId}/backupName/{backupName}

Request headers

Header Value
Authorization Bearer {token} (required)
Content-Type application/json

Request body

Don't supply a request body for this method.

Response

The response is always a 200 OK response, unless you aren't correctly authenticated. Be sure to use the IsSuccess property to evaluate the success or failure of the action.

Example

POST /databasemovement/v1/export/project/12345/environment/5362377c-bc37-4f92-b30e-fe0c1e664cc0/backupName/TestBackupViaAPI
{
    "IsSuccess": true,
    "OperationActivityId": "55eb4327-9346-4c7b-82bd-fe8ef15112c6",
    "ErrorMessage": null,
    "VersionEOL": "9999-12-31T23:59:59.9999999"
}

Help us understand

We want to learn more about how people use Microsoft's custom Help toolkit. Take the survey (in English) and help us understand: https://forms.office.com/r/A4cUJgjkD1.