Skip to main content

Generate API Credentials on CrowdStrike Falcon Platform

This document outlines how to generate API credentials in the CrowdStrike Falcon Console to enable secure programmatic access. These credentials are required for integrations such as the Xshield Security Platform, allowing access to host, host group, and firewall management APIs, and to retrieve firewall events.


API Operations to be Enabled

API CallAccess Level
GET /host-groupsRead-only
GET /hostsRead-only
PUT /host-groupsRead-write
PUT /firewall/policiesRead-write
PUT /firewall/rulesRead-write
PUT /firewall/rule-groupsRead-write
POST /fwmgr/aggregates/events/GET/v1Read-only (firewall events)

Step 1: Log in to CrowdStrike Falcon Console

Use the URL corresponding to your tenant's region:

Region NameFalcon Console URL
US-1https://falcon.crowdstrike.com
US-2https://falcon.us-2.crowdstrike.com
US-GOV-1https://falcon.laggar.gcw.crowdstrike.com
US-GOV-2https://falcon.us-gov-2.crowdstrike.com
EU-1https://falcon.eu-1.crowdstrike.com

Sign in using an account with permission to create API clients.


Step 2: Navigate to API Client Management

From the console:

  • Go to: Support & Resources → Resources & Tools → API Clients and Keys
  • Click Create API Client

Step 3: Create API Client and Assign Required Scopes

  1. Client Details

    • Name: e.g., Xshield API Integration
    • Description: Optional
  2. Assign the Following Scopes:

    Read Access

    Scope GroupScopeUsed For
    HostsReadGET /hosts
    Host GroupsReadGET /host-groups
    Firewall ManagementRead_EventsPOST /fwmgr/aggregates/events/GET/v1

    Read/Write Access

    Scope GroupScopeUsed For
    Host GroupsWritePUT /host-groups
    Firewall ManagementWritePUT /rules, /policies, /rule-groups
  3. Click Create and proceed.


Step 4: Record and Secure the Credentials

On creation, you'll receive:

  • Client ID
  • Client Secret (shown once only)

🔐 Store these credentials securely. The secret cannot be retrieved again.


Step 5: Identify Your CrowdStrike Region

This region value is necessary to construct the correct API URLs and for integration in Xshield.

Console URLCrowdStrike Region Value
https://falcon.crowdstrike.comus-1
https://falcon.us-2.crowdstrike.comus-2
https://falcon.eu-1.crowdstrike.comeu-1
https://falcon.laggar.gcw.crowdstrike.comus-gov-1
https://falcon.us-gov-2.crowdstrike.comus-gov-2

You will use this region value to configure the API endpoint in the Xshield Security Platform.