cfw · 2019-09-04

DescribeDefenseSwitch

POST

Query the list of firewall toggles with Intrusion Defense enabled.

Wire call

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

curl

curl -sS https://cfw.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cfw/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: cfw.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeDefenseSwitch' \
  -H 'X-TC-Version: 2019-09-04' \
  -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.

Field	Type	Description
BasicRuleSwitch	integer	Whether to enable the Basic Protection feature
BaselineAllSwitch	integer	Whether to enable the Security Baseline feature
TiSwitch	integer	Whether to enable the Treat Intelligence feature
VirtualPatchSwitch	integer	Whether to enable the Virtual Patch feature
HistoryOpen	integer	Whether it has been enabled before
ReturnCode	integer	Status code. `0`: Succeeded. Others: Failed
ReturnMsg	string	Status message. `success` and `fail.
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "BasicRuleSwitch": …,
    "BaselineAllSwitch": …,
    "RequestId": "…"
  }
}

Error

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

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cfw.

SecretIdSecretKey

Request bodyvalid JSONPOST cfw.api3.convergecloud.com · DescribeDefenseSwitch

{}

Read-only. Creates nothing.

Recorded example response

{
  "BaselineAllSwitch": 0,
  "BasicRuleSwitch": 0,
  "HistoryOpen": 0,
  "RequestId": "163cb3c8-d744-2c88-3c46-ccee32c6d332",
  "ReturnCode": 0,
  "ReturnMsg": "success",
  "TiSwitch": 0,
  "VirtualPatchSwitch": 0
}