Get the RPS Server Password

Retrieves the plaintext password of a custom RPS (Redirection and Provisioning Service) server. This interface is the only one that returns the password. Every call is recorded in the audit log, and the password itself is not written to the audit details.

Request URL

GET {base_url}/uc-cautop/api/v1/rps-servers/{id}/password

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.

x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
id Yes String The ID of the RPS server. You can obtain the ID using the Query RPS Servers interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.

result Object<RPS_Server_Password> The password of the RPS server.
RPS_Server_Password
Parameter Type Description
id String The unique ID of the RPS server.
password String The plaintext password. Only this interface returns the plaintext value.