Link Search Menu Expand Document


Orchestrator > Orchestrator Server > Users & Authentication > API Keys

Use this page to allow your applications to utilize REST APIs without session authentication and management. You can specify permissions, status, name, and IP allow list for your API keys.

An API key can be passed either in the HTTP request header field X-Auth-Token or as a query parameter apiKey.

NOTE: It is recommended to use different keys for different applications and users.

To add and define a new API key, click the Edit icon and configure the fields below.

Field Description
Key Name Name of the key you are creating.
Key Text you cut, paste, and insert into your client code.
Permission Read-Only or Read-Write.
Description Enter details in this field that describe the purpose of the key you are configuring.
Expiration Set the expiration date if you want a certain application or script to access the key for a fixed amount of time.
Active To display if the key is active or inactive, select Yes or No.
IP Allow List Filters traffic to your private resources through this specified IP range. Traffic is able to pass through with the IP addresses defined in this field.

Back to top

© Copyright 2024 Hewlett Packard Enterprise Development LP. The information contained herein is subject to change without notice. The only warranties for Hewlett Packard Enterprise products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Hewlett Packard Enterprise shall not be liable for technical or editorial errors or omissions contained herein. Aruba Networks and the Aruba logo are registered trademarks of Aruba Networks, Inc. Third-party trademarks mentioned are the property of their respective owners. To view the end-user software agreement, go to HPE Aruba Networking EULA.

Open Source Code:

Hewlett Packard Enterprise Company
Attn: General Counsel
WW Corporate Headquarters
1701 E Mossy Oaks Rd Spring, TX 77389
United States of America