Link Search Menu Expand Document

API Key

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.

FieldDescription
Key NameName of the key you are creating.
KeyText you cut, paste, and insert into your client code.
PermissionRead-Only or Read-Write.
DescriptionEnter details in this field that describe the purpose of the key you are configuring.
ExpirationSet the expiration date if you want a certain application or script to access the key for a fixed amount of time.
ActiveTo display if the key is active or inactive, select Yes or No.
IP Allow ListFilters 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 2022 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 Aruba EULA.