GET /api/apis/versions/{APIVersionID}/package

Exports information about an API version to an export file that can be imported to another platform instance.

Authorization Roles/Permissions: Must have permission to modify the API; an API Admin or Business Admin.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/versions/{APIVersionID}/package[?][migration.export.include.apis=true]
[&migration.pki.export=true][&migration.export.include.resources=true][&migration.export.include.api.connections=true]
[&migration.export.include.api.admins=true][&migration.export.include.policies=true][&migration.operationalpolicy.export=true]
[&migration.qospolicy.export=true][&migration.compliancepolicy.export=true][&migration.export.include.scopes=true]
[&migration.export.include.licenses=true][&migration.export.include.apps=true][&migration.app.pki.export=true]
[&migration.export.include.app.team=true][&migration.export.include.feature.customization.settings=true]
[&migration.export.include.workflow.definitions=true][&migration.export.include.custom.styles=true]
[&migration.export.include.security.domains=true][&migration.export.include.login.domains=true&migration.export.include.message.templates=true

Back to top

Sample Request

The example below shows a request to export the information for the specified API version.

Request URL #1

With no options selected

https://{hostname}/api/apis/versions/07990ae3-f77a-422a-9286-6a38d6aaa91b.acmepaymentscorp/package?
exportVersion=current&wrapInHTML=true&document.domain={hostname}

Request URL #2

With all options selected.

https://{hostname}/api/apis/versions/07990ae3-f77a-422a-9286-6a38d6aaa91b.acmepaymentscorp/package?exportVersion=current&migration.operationalpolicy.export=true
&migration.qospolicy.export=true&migration.pki.export=true&migration.export.include.api.admins=true&migration.export.include.api.connections=true
&migration.export.include.scopes=true&migration.export.include.resources=true&wrapInHTML=true&document.domain={hostname}&download=true

Sample request headers

GET /api/apis/versions/07990ae3-f77a-422a-9286-6a38d6aaa91b.acmepaymentscorp/package?exportVersion=current
&wrapInHTML=true&document.domain=acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

application/octet-stream

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path string Required The unique ID for a specific API version.
wrapInHTML Query boolean Optional If specified with value true, wrap the response in HTML. Only useful if you are running the API in a browser. For more information about this optional parameter, see File Upload with Ajax.
document.domain Query string Optional The document domain (normally the same as the {hostname} value).
download Query string Optional If set to true (the default), the content is downloaded. If set to false, the user is prompted for content disposition.
migration.operationalpolicy.export Query boolean Optional

If specified with value true, include in export file:

  • Operational policies
migration.qospolicy.export Query boolean Optional

If specified with value true, include in export file:

  • Quality of Service policies
migration.pki.export Query boolean Optional

If specified with value true, include in export file:

  • API Private Key + Certificate (if existing; must be imported via the Policy Manager Console)
migration.export.include.scopes Query boolean Optional

If specified with value true, include in export file:

  • Scopes
migration.export.include.resources Query boolean Optional If specified with value true, resources and documentation are included in the export file.
migration.export.include.api.connections Query boolean Optional

If specified with value true, include in export file:

  • Contracts
migration.export.include.api.admins Query boolean Optional

If specified with value true, include in export file:

  • API Admins.
    Note: The user's relationship to the API is exported, not the actual user resource; in order for the relationship to be preserved in the target environment, the user must exist in the target environment when import is done. If not: a) create and invite the user, b) create the user and re-import, or c) invite a different user.
migration.export.include.services Query boolean Optional

If not specified, or specified with value true, include in export file:

  • API Implementation Services

Back to top

Response

If successful, this operation returns HTTP status code 200, with the API version data returned in a file attachment named apiversion-export.zip.

Back to top

Sample Response

The sample response below shows successful completion of this operation. The export file is downloaded as specified in the request parameters.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Expires: Mon, 09 Jun 2014 15:58:45 GMT
Content-Disposition: attachment;filename="apiversion-export.zip"

Sample response body

The response body is the apiversion-export.zip file. Click here to view an example.

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

application/octet-stream

Content-Disposition attachment;filename="apiversion-export.zip"

Back to top

Response Body

The response body is the apiversion-export.zip file. Click here to view an example.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics