Admin Config Service (ACS) requirements and compatibility matrix
This page lists basic requirements and compatibility information for the Admin Config Service (ACS) API.
To get started using the ACS API, see Basic setup and usage concepts for the Admin Config Service (ACS) API
Requirements
To use the ACS API with your Splunk Cloud Platform deployment:
- A user's assigned role must contain the capabilities required to access a specific ACS API endpoint. The
sc_admin
role has all required capabilities by default. For a list of required capabilities, see Manage ACS API access with capabilities. - You must have a version of Splunk Cloud Platform that is compatible with the specific ACS feature. For version requirements, see the documentation for individual ACS features.
- Your Splunk Cloud Platform Experience (Victoria or Classic) must be compatible with the ACS feature that you want to use. For Splunk Cloud Platform Experience compatibility, see the ACS compatibility matrix. For more information, see Determine your Splunk Cloud Platform Experience.
- Your deployment must have one or more standalone search heads or a search head cluster. ACS is not supported on single instance deployments.
FedRAMP requirements
The ACS API supports FedRAMP IL2 deployments on Splunk Cloud Platform Classic Experience version 9.1.2308.2xx only.
To run ACS operations on FedRAMP, you must specify the FedRAMP IL2 URL https://admin.splunkcloudgc.com in the API request, instead of the default ACS server URL https://admin.splunk.com. For example:
curl 'https://admin.splunkcloudgc.com/{stack_name}/adminconfig/v2/indexes' \ --header 'Authorization: Bearer eyJraWQiOiJzcGx1bmsuc2VjcmV0Iiwi…'
FedRAMP IL2 deployments do not support ACS maintenance window (maintenance-window
) and authentication token (tokens
) endpoint operations. FedRAMP IL2 deployments do not support the ACS CLI setup
and login
commands, which use the ACS tokens
endpoint to generate authentication tokens.
FedRAMP IL2 deployments do not support editing limits.conf using the Configure Limits UI in Splunk Web. The Configure Limits UI runs on Victoria Experience only, while FedRAMP IL 2 requires Classic Experience.
ACS does not support IP allow list management on FedRAMP High environments. To modify allow lists on FedRAMP High environments you must contact Splunk Support.
For more information on Splunk platform support for FedRAMP, see Compliance at Splunk.
ACS compatibility matrix
The table shows compatibility for ACS-supported features on Victoria Experience and Classic Experience.
ACS-supported feature | Victoria Experience | Classic Experience |
---|---|---|
App permissions | Yes | No |
Authentication tokens | Yes | Yes |
Export apps | Yes | No |
HEC tokens | Yes | Yes |
Indexes | Yes | Yes |
IP allow lists | Yes | Yes |
limits.conf configuration | Yes | No |
Maintenance windows | Yes | Yes |
Outbound ports | Yes | Yes |
Private apps | Yes | Yes * |
Private connectivity | Yes | Yes |
Restarts | Yes | Yes |
Splunkbase apps | Yes | Yes * |
Users, roles, and capabilities | Yes | Yes |
ACS CLI | Yes | Yes ** |
FedRAMP IL2 | No | Yes |
Terraform Provider for ACS | Yes | Yes |
*Classic Experience supports ACS app management on all search heads except premium search heads.
**Classic Experience supports ACS CLI bulk operations for HEC tokens and indexes only.
Determine your Splunk Cloud Platform Experience
Each Splunk Cloud Platform stack has an Experience designation: Classic or Victoria. Some ACS features are compatible with Victoria Experience only, while others, such as private app management, provide different endpoints for Classic Experience and Victoria Experience.
To find your Splunk Cloud Platform Experience:
- In Splunk Web, click Support & Services > About.
- In the About panel, under Splunk Cloud, find your Experience: Classic or Victoria.
After you determine your Splunk Cloud Platform Experience, use the ACS feature endpoints that apply to your Experience.
For more information on Splunk Cloud Platform Experience, see Determine your Splunk Cloud Platform Experience in the Splunk Cloud Platform Admin Manual.
About the Admin Config Service (ACS) API | Basic setup and usage concepts for the Admin Config Service (ACS) API |
This documentation applies to the following versions of Splunk Cloud Platform™: 9.1.2308, 9.1.2312, 9.2.2403, 9.2.2406 (latest FedRAMP release)
Feedback submitted, thanks!