Update Credentials

URL:
https://<root>/usagestatistics/update/credentials
Methods:
POST
Required Capability:
Access allowed only with the default administrator role
Version Introduced:
10.9

Description

The update/credentials operation updates the credentials for the metrics viewer and metrics API.

Metrics viewer

By default, the initial administrator account credentials that were created during the configuration of your organization are used to access the metrics viewer.

Metrics API

System-generated credentials are created and used to access the metrics API. It is recommended that these credentials be updated once your organization is configured.

Request parameters

ParameterDetails

resource

Specifies whether the updated credentials will be applied to the metrics viewer (grafana) or the metrics API (prometheus).

Values: grafana | prometheus

username

The new username for the specified metrics resource.

Example
Use dark colors for code blocksCopy
1
username=metricsadmin

password

The new password for the metrics resource. The new password must be a minimum of eight characters and must contain at least one letter (A-Z, a-z), one number (0-9), and one special character.

Example
Use dark colors for code blocksCopy
1
password=metrics.pass1

Example usage

The following is a sample POST request for the update/credentials operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /context/usagestatistics/update/credentials HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

resource=prometheus&username=metricsadmin&password=metrics.pass1&token=tAn8XQKKU5HhvrvxFmM5_3Yb3qdXwPM4NZID92K0IfxRBf95GKvrHdzd2Euzbi-6OzRHWpYIqIrs0oNHqYkk9cvz4Hx_hlQ1A7ClYGkMlL4YdA-fQMX7YL-0-p4j70KJeVI6tL94sAjZQbrS-b1VN3E5GG6oyhbGGzqvjEQYYGy47m495iZw8kXiSFwWP1FBbyLaJoK2JSMLOpMeg7CqbuyIRLmveFZ0AbJ95_CUb9V_WyYTC4PDkSLv1SKn21TE

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.