Add an API endpoint

Data Integrity Suite

Product
Spatial_Analytics
Data_Integration
Data_Enrichment
Data_Governance
Precisely_Data_Integrity_Suite
geo_addressing_1
Data_Observability
Data_Quality
dis_core_foundation
Services
Spatial Analytics
Data Integration
Data Enrichment
Data Governance
Geo Addressing
Data Observability
Data Quality
Core Foundation
ft:title
Data Integrity Suite
ft:locale
en-US
PublicationType
pt_product_guide
copyrightfirst
2000
copyrightlast
2026

Configure a new API endpoint by selecting an API source and defining which request and response parameters to expose in your pipeline.

Limited Availability: ^ This feature is currently available only in select workspaces and might be subject to change before general availability.

You must have an API source already created. See Add an API source for instructions. When you add an API endpoint, you select which parameters from the API will be exposed for configuration in your pipeline. You can also provide friendly names for parameters and set default values.

  1. Navigate to the API Call section in your pipeline or workflow.
  2. Click Add new Endpoint.
  3. Configure the connection details:
    1. Select the API Source from the dropdown list.
    2. Select the API Endpoint from the available endpoints in the selected API source.
  4. Enter the API Name. This is the name that will appear in your pipeline.
  5. Enter the API Description. Provide a clear description of what this endpoint does.
  6. Configure the request parameters:
    The request configuration section displays all available parameters from the selected endpoint. The content is automatically populated based on your endpoint selection.
    1. Review the list of available parameters.
    2. For each parameter you want to use, select which parameters will be exposed for user entry in the pipeline.
    3. Optionally, provide a default value for any parameter.
    4. Optionally, rename a parameter to a friendlier name that will display in the pipeline or workflow.
    5. Click View sample payload to see an example of the request data structure.
  7. Configure the response parameters:
    The response configuration section allows you to select which response parameters from the API will be available in your pipeline.
    1. Review the list of available response parameters.
    2. Select which response parameters you want to expose for use in your pipeline.
    3. For each selected parameter, provide a friendly name if you want to change the default name.
  8. Click Save to create the API endpoint.
The API endpoint is now configured and ready to use. You can now configure the input and output parameters for this endpoint in your pipeline. After creating an API endpoint, proceed to configure input parameters and configure output parameters.