--- title: "API Configurations" slug: "api-configurations" updated: 2024-01-30T06:10:38Z published: 2024-01-30T06:10:38Z canonical: "help.symphonysummitai.com/api-configurations" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt > Use this file to discover all available pages before exploring further. # API Configurations # **API Configuration** refers to the process of setting up and administering APIs (Application Programming Interface) within a Service Automation environment. This process involves defining the endpoints, protocols, and security measures used to connect and interact with various APIs. # The importance of API configuration is listed in the gif below:![SA configuration pages (1)(1)](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/SA%20configuration%20pages%20(1)(1).gif) ## API Configurations To configure Service Automation in any ITSM tool, data capture from that particular tool becomes a vital activity. Information such as Incident details, Service requests, Custom attributes, customer names, and location names can be configured as API in the API Configurations screen. It displays the total API configurations along with individual count for the specific method type. ### View API Configurations To view API configurations, perform the following steps: 1. Navigate to **Admin > Advanced > Automation > Orchestration.**                                               OR      Navigate to **Orchestration > User > Orchestration**. 2. From the left **MENU**, select **API** **Configurations**.   **API** Configurations list page is displayed.  ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1683005066051.png)Figure: API Configurations List page **Field Description** This table contains the list of fields and their descriptions available on the **API Configurations** **list** page: | Field | Description | | --- | --- | | Total | Displays the total number of API configurations. | | Get | Displays the number of API configurations with GET method. | | Post | Displays the number of API configurations with POST method. | | **DATA SOURCES** | | Data Source Name | Displays the data source name. | | Method Type | Displays the method type. Available options are as follows: - POST - GET | | Content Type | Displays the content type. Available options are as follows: - Application/json | | Active | Displays the status as **True** if it is active. | | Created By | Displays the name of the user who has created the API. | | Last Updated By | Displays the name of the user who has last updated the API. | | Last Updated Date | Displays the date on which the API was last updated. | ### Configure API To configure a new API, perform the following steps: 1. Click "+" icon from the top right corner to configure a new API. API Configurations page is displayed with ***Data Source***, ***Method** **Settings***, ***Headers***, and ***Payload***. 2. Enter all the required details and click **SAVE** to save and create a new API configuration. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1683815574611.png)Figure: API Configurations page **Field Description** This table contains the list of fields and their descriptions available on the **API Configurations** page: | Field | Description | | --- | --- | | **Data Source** | | Data Source Name | Specify the data source name. | | Active | Enable Active checkbox to make the API as active. | | URL | Specify the URL. Click **Validate** to check the validity of the URL. | | Method Settings | | | Method Type | Select the method type. Available options are as follows: - POST - GET | | Content Type | Select the method type. Available options are as follows: - Application/json | | **Headers** | | | Key | Specify the key. | | Value | Specify the value. | | Action | Specify the action. | | Payload | Displays the payload values. | | Dynamic Payload Values | Parameters are dynamic and depends on the API Payload. Specify the parameter values to test the API. Few examples of parameters are as follows: - Tenant - Module Code - Source Type - Catalog ID - Category ID | ### ### Search Control Using Search control, you can filter data across all columns. This acts as a one input search control for the list page. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1684992002202.png) Figure: Search Control ### Export Using Export control, you can export all the data in the form of Excel and JSON. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1684992237613.png) Figure: Export control Note: - Export to Excel/JSON- Exports the current page records. - Export All to Excel/JSON- Exports all the existing records. ### Filters Click **![](https://docs.symphonysummitai.com/download/thumbnails/440696932/image2021-5-6_15-5-16.png?version=1&modificationDate=1620293716678&api=v2)** icon, **Filters** Pop-up page is displayed. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1684992679347.png) Figure: Filters Pop-up **Field Description** The following table describes the fields on the **Filters Pop-up** page: | Field | Description | | --- | --- | | Load Filters | Select to view the available filters. | | Data Source Name | Specify the filter value for **Data Source** column. | | Created By | Specify the filter value for **Created By** column. | | Created Date | Specify the filter value for **Created Date** Source column. | | Last Updated By | Specify the filter value for **Last Updated By** column. | | Last Updated Date | Specify the filter value for **Last Updated Date** column. | | Apply | Click **Apply** to apply the mentioned filters and the filtered APIs gets displayed in API List page. | | Clear | Click **Clear** to delete the selected filters. | | Save/Update Filters | You can provide a name to the multiple filters. Click **Save/Update** filter to save it and later you can view it under **Load Filters**. |