{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":43468,"path":"security-management/add-apis.md","title":"Add APIs","bundle":null,"doc_type":null,"release":"australia","body":"\n# Add APIs\n\nAll the selected capabilities are listed as tabs on the Add APIs page. Add at least one API for each capability.\n\n## Before you begin\n\n**Note:**\n\n- The APIs use ServiceNow Otto for Security Incident Response \\(SIR\\) integration Toolkit skills for code generation and for writing scripts. By default, these skills use Azure Open AI LLM \\(Large Language Model\\). If necessary, you can change the LLM by accessing the ServiceNow Otto® application. The following LLMs are available: Azure Open AI, Now LLM.\n- ServiceNow Otto for Security Incident Response \\(SIR\\) integration Toolkit for Spoke Generation is used to generate flow action which uses Now LLM.\n\nRole required: sn\\_si\\_int\\_kit.integration\\_creator\n\n## Procedure\n\n1. Select the capability for which you want to add APIs.\n\n2. To add API, select **Add new API**.\n\n3. Select **API type**.\n\n\n
\n\nOption\n\n\n\nDescription\n\n
\n\n**Choose new API**\n\n\n\n1. Select the **API name**.\n\nThe following details of the selected APIs are displayed:**API documentation**, **API response structure**, **API sample response**.\n\n2. Select **Create API endpoint details**.\n\nA flow designer action is generated.\n\n3. In the Flow designer action section, select the \\[Omitted image \"browse.png\"\\] Alt text:icon to review the Flow Designer action generated by ServiceNow Otto for Security Incident Response \\(SIR\\) integration Toolkit. If necessary, you can update the values.\n4. Select one of the **API classification**.\n - **Pre processing API**: Refers to the initial API calls required by an integration before making the primary API call to obtain the final results. These preliminary calls are essential for tasks such as retrieving necessary identifiers \\(such as host ID\\), fetching relevant information \\(such as OS name\\), or establishing a connection \\(such as starting a session with the host\\). By completing these preparatory steps, the preprocessing API enables the integration to successfully execute the main API call and retrieve the desired outcome.\n - **Results API**: Delivers the final data, while the preprocessing APIs provide the necessary dependencies.\n5. Select **Generate Invocation Script** to generate the invocation script.\n\nYou can modify the script if necessary.\n\n**Note:** Verify that the modified script is validated.\n\n6. Select **Generate Parsing Script** to generate the parsing script.\n\nYou can modify the script if necessary.\n\n**Note:**\n\n - Verify that the modified script is validated.\n - If the generated parsing script isn’t correct and truncated, increase output token limit for the Code generation skill from ServiceNow Otto for Security Incident Response \\(SIR\\) integration Toolkit.\n7. To add multiple APIs, select the **+** icon and repeat from step 2.\n\n\n
\n\n**Choose from existing API**\n\n\n\n1. In **Choose API**, select the API.\n\nThe API details are listed: **API documentation**, **API response structure**, **API sample response**.\n\n2. Select **API classification**.\n - **Pre processing API**: The initial API calls required by an integration before making the primary API call to obtain the final results. These preliminary calls are essential for tasks such as retrieving necessary identifiers \\(such as host ID\\), fetching relevant information \\(such as OS name\\), or establishing a connection \\(such as starting a session with the host\\). By completing these preparatory steps, the preprocessing API enables the integration to successfully execute the main API call and retrieve the desired outcome.\n - **Results API**: Delivers the final data, while the preprocessing APIs provide the necessary dependencies.\n3. Select **Generate Invocation Script** to generate the invocation script.\n\nYou can modify the script if necessary.\n\n**Note:** Verify that the modified script is validated.\n\n4. Select **Generate Parsing Script** to generate the parsing script.\n\nYou can modify the script if necessary.\n\n - Verify that the modified script is validated.\n - If the generated parsing script isn’t correct and is truncated, increase output token limit for the Code generation skill from ServiceNow Otto for Security Incident Response \\(SIR\\) integration Toolkit.\n5. To add multiple APIs, select the **+** icon and repeat from step 2.\n\n\n
4. To add multiple APIs, select the **+** icon and repeat from step 2.\n\n5. Select **Mark as complete**.\n\n At least one API must be configured as a Results API for each capability.\n\n All the APIs are listed for the selected capability.\n\n6. Select **Next** to review and publish the application.\n\n\n"}}