QueryApiKey

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cam/QueryApiKey path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl -sS https://cam.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cam/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: cam.api3.convergecloud.com' \
  -H 'X-TC-Action: QueryApiKey' \
  -H 'X-TC-Version: 2019-01-16' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

This action takes no parameters.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

No response fields are documented for this action beyond the envelope.

{
  "Response": {
    // action-specific fields,
    "RequestId": "…"
  }
}

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

{
  "Response": {
    "Error": {
      "Code": "",
      "Message": "; UserNotExist",
      "code": 0,
      "msg": "UserNotExist",
      "value": null
    },
    "RequestId": "cc2ae468-4222-3c44-8a5e-890cbea29f91"
  }
}