- URL:
- https://<root>/usagestatistics/update/credentials
- Methods:
POST- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The update/credentials operation updates the credentials for the metrics API. Initially, system-generated credentials are created and used to access the metrics API. It is recommended that administrators update these credentials once the organization is configured.
Request parameters
| Parameter | Details |
|---|---|
| Specifies the updated credentials should be applied to the metrics API ( Values: |
| The new password for the metrics API. The new password must be a minimum of eight characters and contain at least one letter (A-Z, a-z), one number (0-9), and one special character. Example |
| Respecifies the new password for the metrics API. The values of Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the update/credentials operation:
POST /<context>/usagestatistics/update/credentials HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
resource=prometheus&password=metrics.pass1&confirmPassword=metrics.pass1&f=pjson&token=tAn8XQKKU5HhvrvxFmM5_3Yb3qdXwPM4NZID92K0IfxRBf95GKvrHdzd2Euzbi-6OzRHWpYIqIrs0oNHqYkk9cvz4Hx_hlQ1A7ClYGkMlL4YdA-fQMX7YL-0-p4j70KJeVI6tL94sAjZQbrS-b1VN3E5GG6oyhbGGzqvjEQYYGy47m495iZw8kXiSFwWP1FBbyLaJoK2JSMLOpMeg7CqbuyIRLmveFZ0AbJ95_CUb9V_WyYTC4PDkSLv1SKn21TEJSON Response example
{"status": "success"}