POST /orgs/{org}/migrations
Initiates the generation of a migration archive.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
org |
String | Yes |
The organization name. The name is not case sensitive. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
repositories[] |
Array | Yes |
A list of arrays indicating which repositories should be migrated. |
exclude_attachments |
Boolean | No |
Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). Default value: false |
exclude_owner_projects |
Boolean | No |
Indicates whether projects owned by the organization or users should be excluded. from the migration. Default value: false |
lock_repositories |
Boolean | No |
Indicates whether repositories should be locked (to prevent manipulation) while migrating data. Default value: false |
exclude_git_data |
Boolean | No |
Indicates whether the repository git data should be excluded from the migration. Default value: false |
exclude_metadata |
Boolean | No |
Indicates whether metadata should be excluded and only git source should be included for the migration. Default value: false |
exclude_releases |
Boolean | No |
Indicates whether releases should be excluded from the migration (to reduce migration archive file size). Default value: false |
org_metadata_only |
Boolean | No |
Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). Default value: false |
exclude[] |
Array | No |
Exclude related items from being returned in the response in order to improve performance of the request. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.