Create a new API source by providing the Open API specification and authentication
details. An API source represents a configured connection to an external API.
Limited Availability: ^ This
feature is currently available only in select workspaces and might be subject to
change before general availability.
When you add an API source, you provide the API specification and configure how to
authenticate with the API. You can supply the Open API specification as a URL or
upload a file.
-
Navigate to the API Call section in your pipeline or workflow.
-
Click Add API Source.
-
Choose how to provide the Open API specification:
-
To use a URL: Select Open API Spec
URL and enter the URL to the Open API
specification.
-
To upload a file: Select
Upload and drag and drop a file or click to
browse and select the Open API specification file.
-
Enter the Base URL for the API. This is the root URL
where all API endpoints are located.
-
Enter an API Source Name. Use a descriptive name that
identifies this API source.
-
Select the Authentication Type from the dropdown. The
available options are:
-
apiKey: Add the API secret.
-
Bearer token: Add the bearer token.
-
Click Test authentication using API endpoint to verify
that your credentials are correct.
Note: The system will attempt to connect to the API
using the provided credentials. A success message indicates that
authentication is working correctly.
-
Click Save to create the API source.
The API source is now created and available for use. You can
now add endpoints to this API source and use them in your pipelines. After creating an
API source, proceed to add an API endpoint to define the specific operations you want to
use.