Generate an API Key
As an Administrator, you can generate an API key for your account. This key can be used as an alternative method to authenticate REST API requests to MetaDefender Storage Security — with the exception of user and API key management operations.
To generate an API key, follow these steps:
- Navigate to the Settings page and click on the Users tab
- Find your user in the list, click on the three dots to the right of the list entry and select "Generate an API Key"
- Click on "Generate", then click the copy button and store your API Key somewhere secure. Afterwards, click on "Save changes".
The API key can be copied only at this step and is saved only after clicking the save changes button. If an API key already exists, it will be updated.
API keys of a user are invalidated on a password change or reset operation.
The following operations are not allowed using an API key:
- Generate an API key: GET /api/apikey/generate
- Retrieve an API key: GET /api/apikey
- Add an API key: POST /api/apikey
- Update an API key: PUT /api/apikey
- Delete an API key: DELETE /api/apikey/{id}
- Enumerate active users: GET /api/user/active/{startIndex}/{count}
- Create an user: POST /api/user/create
- Update user role: PUT /api/user/role
- Enumerate user requests: GET /api/user/requests
- Remove a user: DELETE /api/user/{userId}
- Update user: PUT /api/user
- Validate password: POST /api/user/validation
Was this page helpful?