Fetching an API definition for Azure API Management | Qlik Cloud Help
Skip to main content

Fetching an API definition for Azure API Management

Export an API definition as a JSON file compatible with Azure API Management from API Designer.

  • You have installed cURL. For more information, see the cURL documentation.
  • You have created an API in API Designer.
  1. Open a command line and enter the following command to export your API definition:
    curl --header "Authorization:Bearer {userToken}" -X GET -o {outFile}.json https://apid.{region}.cloud.talend.com/api/v1/api-definitions/{api-id}?format=Swagger20Azure
  2. Add the correct parameters:
    Parameter Description
    {userToken} Token generated from Qlik Talend Cloud.
    {outFile} Path and filename of your API definition. For example: contactsapi.json
    {region} Region for your Qlik Talend Cloud account. The value can be:
    • us-west
    • us
    • eu
    • ap
    • au

    For more information, see Accessing Talend Cloud applications.

    {api-id} ID of the API version to fetch. To get it, open your API in API Designer and go to Settings > MANAGEMENT API or use the GET method on the /api-definitions endpoint to get a list of API definitions with their IDs.
  3. Execute the command.

Your API definition is exported as a JSON file compatible with Azure API Management and saved in the selected directory.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!