To authenticate and connect using the Google Security Operations SOAR API,
you must first create an API key.
You can access the SOAR API over port 443.
To create a new API key:
Go toSettings>Advanced>API keys.
ClickaddAdd.
On theAPIpage, enter the name for
the application that requires API access to Google SecOps SOAR.
Select the required permission group for this API key. The
groups on this menu are defined on theOrganizations>Permissionspage.
Select the environments to associate with the API key. If you select all current environments, the key only applies to environments that exist at the time of creation. To confirm access to new environments, use a permission group withAll Environmentsenabled.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-07 UTC."],[[["\u003cp\u003eAPI keys provide authentication for connecting to the Google SecOps SOAR API, accessible over port 443.\u003c/p\u003e\n"],["\u003cp\u003eNew API keys can be created by navigating to Settings > Advanced > API keys and clicking the plus icon.\u003c/p\u003e\n"],["\u003cp\u003eWhen creating an API key, you must specify the application name, permission group, environment, and SOC role.\u003c/p\u003e\n"],["\u003cp\u003ePermission groups for API keys are defined in the Organizations > Permissions screen.\u003c/p\u003e\n"],["\u003cp\u003eOnce saved, the newly created API key will appear in the API keys screen.\u003c/p\u003e\n"]]],[],null,["Manage API keys \nSupported in: \nGoogle secops [SOAR](/chronicle/docs/secops/google-secops-soar-toc)\n| **Note:** If you've migrated to Google Cloud, the original permissions group is replaced by IAM permissions. For more information, see \\[Migrate to Google Cloud\\](/chronicle/docs/soar/admin-tasks/advanced/migrate-to-gcp).\n\nTo authenticate and connect using the Google Security Operations SOAR API, you must first create an API key.\n\nYou can access the SOAR API over port 443.\n\nTo create a new API key:\n\n1. Go to **Settings \\\u003e Advanced \\\u003e API keys**.\n2. Click add **Add**.\n3. On the **API** page, enter the name for the application that requires API access to Google SecOps SOAR.\n4. Select the required permission group for this API key. The groups on this menu are defined on the **Organizations \\\u003e\n Permissions** page.\n5. Select the environments to associate with the API key. If you select all current environments, the key only applies to environments that exist at the time of creation. To confirm access to new environments, use a permission group with **All Environments** enabled.\n6. Select the SOC role. For information about SOC roles, see [Control access to the platform](/chronicle/docs/soar/admin-tasks/advanced/control-access-to-platform).\n7. Click **Save** . The new key appears on the **API keys** page.\n\n**Need more help?** [Get answers from Community members and Google SecOps professionals.](https://security.googlecloudcommunity.com/google-security-operations-2)"]]