API Keys
Developer Portal
Accessing the Developer Portal
1.
2.
1. Click on Sign In
2. Under Admin Panel in the Sidebar, Click on API Keys
3. Here is the Developer Portal Section
Creating New API Key
1. Click on "Create new secret key"
2. Name your key in this field
3. Here, you can see different permission scopes: All, Read Only, and Restricted
4. Permission: All
5. Permission: Read Only
6. Permission: Restricted
7. Select Permission for each category
8. Click on Create
9. A popup with a key activation link appears
10. Click here to follow the link
11. In the new tab, Click on Allow access to activate your key
12. Copy your secret key and click on "Done"
13. Your new key will appear in the list of API keys.
Testing API Key in the REST API Playground
1. Server URL Configuration
your_server_name placeholder with this server URL. This URL serves as the base endpoint for all API requests during testing.
2. Click on View API documentation, you'll be redirected to REST API documentation
3. Choose one of the endpoints to test your new key
4. Paste your new key in the Ocp-Apim-Subscription-Key field
5. Inserting the Server URL
your_server_name field to ensure proper API functionality during testing.
6. Give the required parameters
7. Click on Send API Request
8. The response from the API can be seen here
Deleting API Key
1.
2.
3.
1. Navigate to the API Keys List
2. Click the delete icon next to the key you want to remove
Click on "Revoke"
The key has been removed from the API Keys List
