Query Secret Key of an Onsite Proxy Instance

Request URL

GET {base_url}/{api_path}/onsiteproxy/getpassword?access_token={access_token}

Request parameters


Parameter	Required	Type	Description
id	Yes	Integer	The unique ID of an Onsite Proxy instance. Note: You can query instance ID using Search Specific Onsite Proxy Instances.
type	Yes	String	Password type. Valid value: `secret_key`: Secret key for connection.

Response parameters


Parameter	Type	Description
errcode	Integer	Returned error code. `0`: Succeed. Non-zero value: Failed. Note: You can check the error code and error message in Error Code and Error Message.
errmsg	String	Returned message. `SUCCESS`: Succeed. `FAILURE`: Failed.
password	String	Secret key for connection.

Examples

Query the secret key of an Onsite Proxy instance (ID: 24).

Request example

GET /openapi/v1.0/onsiteproxy/getpassword?id=24&type=secret_key&access_token=fJ71SE6TCRLAGUyv2J4YQco3jeqE1H47&id=80&type=reg_password HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "password": "tPXXXXE7"
}