Manage APIs > Custom APIs > Publishing a custom API
  

Publishing a custom API

You can publish a custom API, and then create a managed API from it.
    1On the API Console page, click the Published APIs tab.
    The Published APIs tab shows all the published APIs according to the last modified date of the published API.
    2Click Publish Custom API.
    The Publish Custom API dialog box appears.
    3On the API Details tab, enter the required values.
    Field
    Description
    Name
    The name that you assign to the custom API is part of the API URL.
    The published API name can contain up to 50 characters, including ASCII letters, digits, Japanese characters, hyphens, dashes, and underscores.
    Version
    Version of the published API. You can't change the version.
    API Type
    Select a protocol from the list. You can select REST or SOAP.
    API URL
    URL for the API. The URL format must conform to the W3C standard.
    You can add path parameters and query parameters to the URL.
    Sample URL: https://reqres.in/api/users/{User_ID}?query=20
    The sample URL contains the following path parameters and query parameters:
    • - {User_ID}: Path parameter for a specific user's ID, which will be replaced by an actual user ID when making the request. For example, https://reqres.in/api/users/2
      • If you have multiple path parameters that you would define later, you can represent them with an asterisk (*) in the URL structure. For example: https://reqres.in/api/users/{User_ID}/*?query=20
      In this URL, {User_ID} indicates the first path parameter, such as a user ID and * indicates any additional path parameters you might add later.
    • - query=20. A query parameter that consists of a key (query) and a value (20). Query parameters come after the question mark (?) and are used to provide additional data for the request.
    Note: API Center
    doesn't validate query parameters.
    For all custom APIs that were created prior to October 2024 release, you can optionally create another custom managed API to update the path parameter and query parameter values dynamically.
    Method
    Select an HTTP method for the API from the available list.
    Default is GET.
    Note:
    To ensure full HTTP standards compliance and improve compatibility with a wider range of API clients, all GET APIs now automatically support the HEAD HTTP method. When a HEAD request is sent to a GET endpoint, the API returns only the metadata of the response headers without the message body, as specified by the HTTP standard. The Swagger definition doesn't contain explicit details for the HEAD method. The HEAD method automatically inherits all rate limit and authorization policies from the corresponding GET method.
    Description
    (Optional) Enter a publishing note.
    4Click Next.
    The Test tab appears.
    Optionally, you can change the values of the path parameters and query parameters.
    5Click Try it Out! to verify if the URL is valid and reachable.
    6You can choose to skip the verification for the custom API, if required.
    If you do not want to test the API URL provided you can enable this option. For example, API Center doesn't verify URLs for SOAP APIs that are imported from Application Integration.
    7Click Next.
    The Summary tab displays all the configured details.
    8Click Publish.
    The published custom API appears on the Published APIs tab in the API Console page.
You can then create a managed API from the published custom API. For more information, see Creating a managed API. You can't test a custom managed API or its operations.