Intro to admin API keys

  • Release version: Australia
  • Updated March 12, 2026
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Intro to admin API keys

    ServiceNow CPQ provides admin API keys that enable you to access administrative functionality via API calls instead of using the CPQ Admin UI browser interface. This capability allows for programmatic access to admin features, streamlining automation and integration scenarios.

    Show full answer Show less

    Accessing the Admin API Keys Page

    Admin API Keys are managed within CPQ Admin under the Utilities section. The Admin API Keys tab lets you create and manage keys that authenticate your API requests to admin endpoints.

    Creating an Admin API Key

    To create a new admin API key, you must provide:

    • Name: Identifier for the API key
    • User ID: The user associated with the key
    • Expiration Date: When the key becomes invalid
    • Permissions: Defines access scope for the API key

    Key permissions include:

    • Read (required, default): Read-only access, mainly for GET requests
    • Edit: Create, read, update, delete capabilities on most objects
    • Deploy: Deploy blueprints and view deployment history
    • Bulk: Import/export data for managed tables
    • Admin: Full admin privileges across all functionality
    • End User Data: Access to end user data APIs

    After setting the parameters and permissions, save the key. Be sure to copy and securely store the key immediately, as it cannot be retrieved later.

    Using Admin API Keys

    When making API calls, use the admin API key as a Bearer Token in the Authorization header:

    • Header key: authorization
    • Header value: Bearer <Admin API key>

    Example header:

    authorization: Bearer QdaUdoiYipb15Le11En8axEuN71FA6Vtcw

    API endpoints differ when using admin API keys:

    • General Admin endpoints: use /api/Admin/... instead of /a/Admin/...
    • Managed Table endpoints: use /api/managedTables/... instead of /a/managedtables/...

    For example, retrieving rules or managed table metadata uses the respective /api/ prefixed endpoints.

    Practical Impact for ServiceNow Customers

    By leveraging admin API keys, you can automate and integrate CPQ admin tasks securely and efficiently without manual UI interaction. Properly assigning permissions ensures least privilege access, enhancing security. Using the correct API endpoints with the bearer token authentication streamlines the use of admin APIs in your workflows.

    You can use admin API calls to access Admin functionality without using the Admin UI interface and a browser.

    CPQ provides admin API keys that you can use to access admin functionality via API calls instead of using a browser and the CPQ Admin interface.

    For an introduction to CPQ admin API keys, view the following video:

    Admin API keys

    Admin API keys page

    To get to the Admin API Keys page in CPQ, click the arrow to expand the Utilities section in CPQ Admin. The Admin API Keys tab appears in the menu.

    Admin keys

    Add an admin API key

    To add a new admin API key, click New at the top of the screen.

    Add Admin Key

    All parameters are required.

    1. Name: the name of the admin API key
    2. User ID
    3. Expiration Date: the expiration date of the key
    4. Permissions: the permissions assigned to the key

    Choose the permissions that fit your use case before clicking Save.

    Admin API key permissions

    API key Permissions

    1. Read (required, default): read-only access, typically for GET requests
    2. Edit: create, read, update, and delete access for most objects, including fields and rules
    3. Deploy: allows the deployment of blueprints and access to deployment history
    4. Bulk: allows importing and exporting data, such as managed tables, to and from CPQ
    5. Admin: full permissions to all Admin functionality
    6. End User Data: access to end user data APIs

    When you are finished assigning permissions, click Save. The dialog box updates to show the new admin API key.

    Add API key

    1. View the admin API key
    2. Copy the key to the clipboard
    3. Close the dialog box
    Important:
    You can copy an admin API key only when it is created. Make sure to copy and store the key.

    Accessing admin APIs by using API keys

    To use an admin API key in API requests, use the API key with Bearer Token authentication.

    • Header: Authorization Header
    • Key: authorization
    • Value: Bearer <Admin API key>

    Example header:

    authorization: Bearer Qda_UdoiYipb15Le11En8axEuN71FA6Vt_cw

    When you use an admin API key, you use different endpoints to access the admin APIs.

    • For general Admin endpoints (/a/Admin/…) the endpoint to use is (/api/Admin/…).

      For example (retrieving a list of rules):

      • API call in Admin UI: /a/Admin/v3/rules?page=0&size=100&sort=modified%2CDESC
      • API call using Admin Keys: /api/Admin/v3/rules?page=0&size=100&sort=modified%2CDESC
    • For managed table endpoints (/a/managed_tables/…) the endpoint to use when accessing with an API key is (/api/managedTables/…)

      For example (retrieving the schema of a managed table):

      • API call in Admin UI: /a/managed_tables/v1/managedTables/{tableName}/metadata
      • API call using Admin Keys: /api/managedTables/v1/managedTables/{tableName}/metadata