Creating & Managing Dell APEX API access key Id and secret
Tue, 06 Feb 2024 18:29:10 -0000
|Read Time: 0 minutes
Create API access key
The following steps will help you to create an API access key:
1. Log in to the Dell Premier Portal.
2. Navigate to Administration à Access Keys.
3. Click on “Create Access Key.”
4. Provide the description (optional) and select the roles to be assigned.
5. The API access key creation and activation process can take some time.You will see the following notification notifying you of your wait time.
You can monitor the status of the “Access Keys” on the home page.
6. Once the key is created and ready, the status will change to “Ready”.
7. Now you can view the access key and secret. Make sure to record the secret somewhere or export to CSV, because it will only be shown to you once.
8. Once the secret has been displayed, the status changes to “Active.”
9. The Access key and secret is valid for one year.
Manage API access key on console
Once the API access key is in the “Active” status, you can perform following operations.
- View: This will show the following details about the access key:
a. Description
b. Status
c. Expiration date
d. Last used
e. Assigned roles
f. Created on - Edit: This option will allow you to update the following details:
a. Description
b. Assigned roles - Deactivate: It will deactivate the access key
- Delete: This will delete the access key
Manage API access key using APIs
Base URL à https://apex.apis.dell.com/apex
API | Details |
POST /rest/v1/api-access-keys/{accessKeyId}/generate-secret | To generate a secret for an existing access key |
DELETE /rest/v1/api-access-keys/{accessKeyId}?async=true | To delete an access key |
PATCH /rest/v1/api-access-keys/{accessKeyId}
| To update an access key (this includes activating, deactivating, modifying, or updating its description) |
GET /rest/v1/api-access-keys?all-org-users={all-org-users}&offset={offset}&limit={limit}
| To list all access keys for users in an organization |
GET /rest/v1/api-access-keys/{accessKeyId}
| To get the details of an individual access key |
Role
- Administrator: The Administrator role can view, edit, and delete access keys created by themselves and other users.
- Non-Administrator: The Non-Administrator role can view, edit, and delete only the access keys created by themselves.
Author: Ratnesh Yadav