Migrate

Summary

The Migration REST API provides application migration to the API Manager's client registry

Description

With the Migrate API, it is possible to import & export applications to and from the Portal for onboarding & upgrading

Resources

Resource Since Version Description
POST /api/portal/v1.3/migrate/applications/export Creates an export of applications based on the export options posted in a form data
POST /api/portal/v1.3/migrate/applications/export/create Creates a set of export options associated with the current http session
GET /api/portal/v1.3/migrate/applications/export/download Exports Application data for migration to other API Gateways
POST /api/portal/v1.3/migrate/applications/export/json Creates an export of applications based on the export options posted as a JSON object
POST /api/portal/v1.3/migrate/applications/import Imports applications to the API Gateway

POST /api/portal/v1.3/migrate/applications/export

Summary

Creates an export of applications based on the export options posted in a form data

Description

Creates an export file based on options including the password used to encrypt the resulting export, export elements: apikeys, oauth & quotas, the filename of the export, and the list of application ids for inclusion in the export. The exported data is returned as part of the response body

Parameters

Parameter Description Data Type Location Required Multiple
apikeys True/False. Include/Exclude api keys String form Required
oauth True/False. Include/Exclude oauth credentials String form Required
quota True/False. Include/Exclude quotas, if available String form Required
filename The name of the export file String form
password The password used to encrypt the exported file String form
appIds The list of identifiers for the applications to be exported List form Required

Status Codes

HTTP Status Code Reason
200 OK
500 Internal Server Error

POST /api/portal/v1.3/migrate/applications/export/create

Summary

Creates a set of export options associated with the current http session

Description

Creates a set of export options associated with the current http session. Options include the password used to encrypt the resulting export, export elements: apikeys, oauth & quotas, the filename of the export, and the list of application ids for inclusion in the export. The exported data can be retrieved subsequently with a GET request

Parameters

Parameter Description Data Type Location Required Multiple
- The options for creating an application export file ExportOptions body Required

Status Codes

HTTP Status Code Reason
204 No Content
500 Internal Server Error

Example

POST https://localhost:8075/api/portal/v1.3/migrate/applications/export/create

Request

{
  "filename" : "export.dat",
  "password" : "1223425",
  "appIds" : [ "c95b7c70-fe01-4e31-8f1f-cdd977812d7d" ],
  "quota" : false,
  "oauth" : true,
  "apikeys" : false
}

Response
HTTP 1.1 200 OK
{
  "filename" : "export.dat",
  "password" : "1223425",
  "appIds" : [ "c95b7c70-fe01-4e31-8f1f-cdd977812d7d" ],
  "quota" : false,
  "oauth" : true,
  "apikeys" : false
}

GET /api/portal/v1.3/migrate/applications/export/download

Summary

Exports Application data for migration to other API Gateways

Description

Retrieves the export options associated with the current user HTTP session and creates a stream or returns the exported data in response body.

Parameters

Parameter Description Data Type Location Required Multiple
filename Optional. If present this method will return an octet stream with an file attachment of the same name String query

Status Codes

HTTP Status Code Reason
200 OK
400 Bad Request
500 Internal Server Error

POST /api/portal/v1.3/migrate/applications/export/json

Summary

Creates an export of applications based on the export options posted as a JSON object

Description

Creates an export file based on options including the password used to encrypt the resulting export, export elements: apikeys, oauth & quotas, the filename of the export, and the list of application ids for inclusion in the export. The exported data is returned as part of the response body

Parameters

Parameter Description Data Type Location Required Multiple
- Export options ExportOptions body Required

Status Codes

HTTP Status Code Reason
204 No Content
500 Internal Server Error

Example

POST https://localhost:8075/api/portal/v1.3/migrate/applications/export/json

Request

{
  "filename" : "export.dat",
  "password" : "1223425",
  "appIds" : [ "c95b7c70-fe01-4e31-8f1f-cdd977812d7d" ],
  "quota" : false,
  "oauth" : true,
  "apikeys" : false
}

Response
HTTP 1.1 200 OK
{
  "filename" : "export.dat",
  "password" : "1223425",
  "appIds" : [ "c95b7c70-fe01-4e31-8f1f-cdd977812d7d" ],
  "quota" : false,
  "oauth" : true,
  "apikeys" : false
}

POST /api/portal/v1.3/migrate/applications/import

Summary

Imports applications to the API Gateway

Description

Imports a set of applications and assocated API Keys and OAuth credentials, encrypted files require a decryption password

Parameters

Parameter Description Data Type Location Required Multiple
file The file containing application data to be imported File form Required
password Password to be used for decryption String form
organizationId The Organization to associate the imported applications with. If applicable, for Core OAuth this parameter will be ignored String form Required
userId The user to associate the applications with. Default is the API Admin String form Required
type The type of application response required. THe only valid option is iframe - this is for ajax based calls that require an iFrame, i.e. Internet Explorer version prior to version 9. String query Required

Status Codes

HTTP Status Code Reason
500 Internal Server Error