Skip to main content Skip to complementary content
Qlik Resources
Loading SearchUnify's search If you need assistance with your product, please contact Qlik Support.
Qlik Customer Portal
Loading SearchUnify's search If you need assistance with your product, please contact Qlik Support.
Qlik Customer Portal

Defining general API information

Edit general information about your API version and define its media types, server URLs, and security schemes.

Procedure

  1. Access the general information page of your API.
    This page opens automatically after creating your API. You can also open it by clicking the name of your API at the top of the left panel.
  2. In the General section, edit the version, description, contact information, license details, and terms of service for your API.
    Information noteNote: The name of your API can be changed from the Talend Cloud API Designer homepage. For more information, see Renaming an API.
    General section of the Petstore API.
  3. Edit the Media types section to add or remove media types.
    The media types defined in this section are global, they are applied to the whole API version. They can also be defined at the operation level.
  4. Add your server URLs in the Server URLs section.
    The server URLs defined in this section are global, they are applied to the whole API version. Once they are defined, your server URLs appear below the name of your API in the top of the left panel, along with the mock endpoint if it is enabled.

    Published server URLs are visible in the live documentation and in the portal. The first published server URL is also used when trying the API in Talend Cloud API Tester. For more information, see Trying your API in Talend Cloud API Tester. Server URLs that are not published are only visible in Talend Cloud API Designer.

    Information noteNote: If you have several server URLs, the first one in the list is used by default when you try your API in Talend Cloud API Tester.
    Server URLs section of the Petstore API.
  5. Define the security for the API in the Global security and Security schemes sections.
    The security defined in this section is global, it is applied to the entire API version. It can also be defined at the resource and operation levels.

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!

Leave your feedback here