---
title: "Partial export API"
method: POST
path: "/migrations/partialexport"
tags: ["Migrations"]
---

# Partial export API

`POST /migrations/partialexport`

Using the partial-export API, we can export one or more of our projects and choose to send the package to the destination Octopus Server's package feed.

## Request body

- CreateMigrationPartialExportTaskCommand — Using the partial-export API, we can export one or more of our projects and choose to send the package to the destination Octopus Server's package feed.
  - `DestinationApiKey` string — The API key of your destination server *(Where you'll be importing this exported package)*
  - `DestinationPackageFeed` string — The destination Octopus Server base URL
  - `DestinationPackageFeedSpaceId` string — The ID of the Space the Destination Package Feed is located in
  - `EncryptPackage` boolean — Encrypt the contents of your migration package *(Uses the `Password` as a shared key so this can be decrypted by your destination server). Defaults to false if not provided*
  - `FailureCallbackUri` string — A webhook URL you can add if you wish to be notified on failure of the migration task *(Your Octopus Server will call this URL using a GET request)*
  - `IgnoreCertificates` boolean — Excludes certificates from partial export
  - `IgnoreDeployments` boolean — Excludes deployments from partial export
  - `IgnoreMachines` boolean — Excludes machines from partial export
  - `IgnoreTenants` boolean — Excludes tenants from partial export
  - `IncludeTaskLogs` boolean — Include the task log folder as part of the export
  - `PackageId` string — Package Name/ID for your export *(Defaults to `Octopus.Space.Migration` if not provided)*
  - `PackageVersion` string — SemVer package version for your export *(Defaults to `1.0.0-{RandomStringGenerator.Generate(8)}` if not provided)*
  - `Password` string, required — Password to encrypt both the migration package and any sensitive values (This is the shared key between partial-export and import migrations)
  - `Projects` string[], required — Projects to include in the migration
  - `SpaceId` string
  - `SuccessCallbackUri` string — A webhook URL you can add if you wish to be notified on successful completion of the migration task *(Your Octopus Server will call this URL using a GET request, appending the `packageId` and `packageVersion` to the URL as querystring parameters)*

## Response `200`

The requested partial export task that has been queued.

- MigrationPartialExportResource
  - `DestinationApiKey` string
  - `DestinationPackageFeed` string
  - `DestinationPackageFeedSpaceId` string
  - `EncryptPackage` boolean
  - `FailureCallbackUri` string
  - `Id` string — Gets or sets a unique identifier for this resource.
  - `IgnoreCertificates` boolean
  - `IgnoreDeployments` boolean
  - `IgnoreMachines` boolean
  - `IgnoreTenants` boolean
  - `IncludeTaskLogs` boolean
  - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
  - `Links` object — Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  - `PackageId` string
  - `PackageVersion` string
  - `Password` string
  - `Projects` string[]
  - `SpaceId` string
  - `SuccessCallbackUri` string
  - `TaskId` string

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.dev/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.dev/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/revisions/63b4166a0686/schema)