Support Open Console

Cloud One Application Security API (1)

Download OpenAPI specification:Download

open_api

Get account's groups.

get/accounts/groups

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Responses
200

List of groups

Response samples
application/json
[
  • {
    }
]

Add new group.

post/accounts/groups

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
Request Body schema: application/json
name
required
string [ 1 .. 100 ] characters
Responses
200

New group added

400

Account does not exist.

403

Unauthorized access.

409

Group name already exists.

422

Incorrect payload.

Request samples
application/json
{
  • "name": "string"
}
Response samples
application/json
{
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "activated_on": "2019-08-24T14:15:22Z",
  • "created_on": "2019-08-24T14:15:22Z",
  • "credentials": {
    },
  • "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
  • "metadata": {
    },
  • "name": "string",
  • "settings": {
    },
  • "status": "active",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Delete group from account.

delete/accounts/groups/{group_id}

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Responses
204

Group deleted successfully

Get a group's detail.

get/accounts/groups/{group_id}

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Responses
200

Group detail

Response samples
application/json
{
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "activated_on": "2019-08-24T14:15:22Z",
  • "created_on": "2019-08-24T14:15:22Z",
  • "credentials": {
    },
  • "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
  • "metadata": {
    },
  • "name": "string",
  • "settings": {
    },
  • "status": "active",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Update group information.

put/accounts/groups/{group_id}

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Request Body schema: application/json
name
required
string [ 1 .. 100 ] characters
Responses
204

Group updated successfully

422

Unprocessable Entity

Request samples
application/json
{
  • "name": "string"
}
Response samples
application/json
{
  • "code": 0,
  • "errors": { },
  • "message": "string",
  • "status": "string"
}

Get settings for a group.

get/accounts/groups/{group_id}/settings

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Responses
200

Group settings.

Response samples
application/json
{
  • "credential_stuffing": "disable",
  • "file_access": "disable",
  • "ip_protection": "disable",
  • "malicious_file_upload": "disable",
  • "malicious_payload": "disable",
  • "rce": "disable",
  • "redirect": "disable",
  • "sqli": "disable"
}

Update group settings.

put/accounts/groups/{group_id}/settings

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Request Body schema: application/json
credential_stuffing
string
Enum: "disable" "report" "mitigate"
file_access
string
Enum: "disable" "report" "mitigate" "learn"
ip_protection
string
Enum: "disable" "report" "mitigate"
malicious_file_upload
string
Enum: "disable" "report" "mitigate"
malicious_payload
string
Enum: "disable" "report" "mitigate"
rce
string
Enum: "disable" "report" "mitigate" "learn"
redirect
string
Enum: "disable" "report" "mitigate"
sqli
string
Enum: "disable" "report" "mitigate"
Responses
204

Group settings updated successfully

422

Unprocessable Entity

Request samples
application/json
{
  • "credential_stuffing": "disable",
  • "file_access": "disable",
  • "ip_protection": "disable",
  • "malicious_file_upload": "disable",
  • "malicious_payload": "disable",
  • "rce": "disable",
  • "redirect": "disable",
  • "sqli": "disable"
}
Response samples
application/json
{
  • "code": 0,
  • "errors": { },
  • "message": "string",
  • "status": "string"
}

Return the Illegal File Access policy.

get/security/file_access/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Responses
200

Retrieved the file access policy.

Response samples
application/json
{
  • "read_control": {
    },
  • "write_control": {
    }
}

Update the Illegal File Access policy.

put/security/file_access/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Request Body schema: application/json
object (FileAccessGlobRuleAlgoSettings)
object (FileAccessGlobRuleAlgoSettings)
Responses
204

Successfully updated the file access policy.

409

Failure to validate the file access policy rules.

422

Unprocessable Entity

Request samples
application/json
{
  • "read_control": {
    },
  • "write_control": {
    }
}
Response samples
application/json
{
  • "code": 0,
  • "errors": { },
  • "message": "string",
  • "status": "string"
}

Return the IP Protection Policy.

get/security/ip_protection/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Responses
200

Successfully retrieved the IP Protection policy.

Response samples
application/json
{
  • "ip_feeds": {
    },
  • "ip_filter": {
    },
  • "trusted_subnets": {
    }
}

Update the IP Protection policy.

put/security/ip_protection/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Request Body schema: application/json
object (IpProtectionPolicyIpFeedsSettings)
object (IpProtectionPolicyIpFilterSettings)
object (IpProtectionPolicyTrustedSubnetsSettings)
Responses
204

Successfully updated the IP Protection policy.

422

Unprocessable Entity

Request samples
application/json
{
  • "ip_feeds": {
    },
  • "ip_filter": {
    },
  • "trusted_subnets": {
    }
}
Response samples
application/json
{
  • "code": 0,
  • "errors": { },
  • "message": "string",
  • "status": "string"
}

Add a rule to the IP Filtering of the IP Protection Policy.

post/security/ip_protection/{group_id}/policy/ip_filter/configuration/rules

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Request Body schema: application/json
action
required
string
Enum: "block" "captcha"
object (TimeRange)
match
required
string
Responses
201

Successfully added IP filter rule.

422

Unprocessable Entity

Request samples
application/json
{
  • "action": "block",
  • "active_period": {
    },
  • "match": "string"
}
Response samples
application/json
{
  • "code": 0,
  • "errors": { },
  • "message": "string",
  • "status": "string"
}

Remove a rule from the IP Filtering of the IP Protection Policy.

delete/security/ip_protection/{group_id}/policy/ip_filter/configuration/rules/{match}

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
match
required
string
Responses
204

Successfully deleted the IP filter rule

Add a rule to the Trusted IPs of the IP Protection Policy.

post/security/ip_protection/{group_id}/policy/trusted_subnets/configuration/rules

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Request Body schema: application/json
object (TimeRange)
match
required
string
Responses
201

Successfully added trusted subnets rule.

422

Unprocessable Entity

Request samples
application/json
{
  • "active_period": {
    },
  • "match": "string"
}
Response samples
application/json
{
  • "code": 0,
  • "errors": { },
  • "message": "string",
  • "status": "string"
}

Remove a rule from the Trusted IPs of the IP Protection Policy.

delete/security/ip_protection/{group_id}/policy/trusted_subnets/configuration/rules/{match}

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
match
required
string
Responses
204

Successfully deleted the trusted subnets rule

Return the Malicious File Upload policy.

get/security/malicious_file_upload/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Responses
200

Successfully retrieved the file upload policy.

Response samples
application/json
{
  • "av_scanning": {
    },
  • "size_check": {
    }
}

Update the Malicious File Upload policy.

put/security/malicious_file_upload/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Request Body schema: application/json
object (MaliciousFileUploadPolicyAVScanningSettings)
object (MaliciousFileUploadPolicySizeCheckSettings)
Responses
204

Successfully updated the file upload policy.

422

Unprocessable Entity

Request samples
application/json
{
  • "av_scanning": {
    },
  • "size_check": {
    }
}
Response samples
application/json
{
  • "code": 0,
  • "errors": { },
  • "message": "string",
  • "status": "string"
}

Return the Malicious Payload policy.

get/security/malicious_payload/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Responses
200

Returns malicious payload policy.

404

Could not find specified group.

Response samples
application/json
{
  • "malicious_pattern_match": {
    }
}

Update the Malicious Payload policy.

put/security/malicious_payload/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Request Body schema: application/json
required
object (MaliciousPayloadPatternAlgoSettings)
Responses
204

Malicious payload policy updated.

404

Could not find specified group.

422

Unprocessable Entity

Request samples
application/json
{
  • "malicious_pattern_match": {
    }
}
Response samples
application/json
{
  • "code": 0,
  • "errors": { },
  • "message": "string",
  • "status": "string"
}

Return the Remote Command Execution policy.

get/security/rce/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Responses
200

Successfully retrieved the RCE policy.

Response samples
application/json
{
  • "exec_control": {
    },
  • "http_params": {
    }
}

Update the Remote Command Execution policy.

put/security/rce/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Request Body schema: application/json
object (CommandRulesAlgoSettings)
object (RcePolicyHttpParamsSettings)
Responses
204

Successfully updated the Rce policy.

409

Failure to validate the Rce policy rules.

422

Unprocessable Entity

Request samples
application/json
{
  • "exec_control": {
    },
  • "http_params": {
    }
}
Response samples
application/json
{
  • "code": 0,
  • "errors": { },
  • "message": "string",
  • "status": "string"
}

Return the Open Redirect policy.

get/security/redirect/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Responses
200

Retrieved the redirect policy.

Response samples
application/json
{
  • "redirect_control": {
    }
}

Update the Open Redirect policy.

put/security/redirect/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Request Body schema: application/json
required
object (RedirectGlobRuleAlgoSettings)
Responses
204

Successfully updated the redirect policy.

409

Failure to validate the redirect policy rules.

422

Unprocessable Entity

Request samples
application/json
{
  • "redirect_control": {
    }
}
Response samples
application/json
{
  • "code": 0,
  • "errors": { },
  • "message": "string",
  • "status": "string"
}

Return the SQL Injection policy.

get/security/sqli/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Responses
200

Retrieved the SQLi policy.

Response samples
application/json
{
  • "always_false": {
    },
  • "always_true": {
    },
  • "bad_function": {
    },
  • "http_params": {
    },
  • "stacking_queries": {
    },
  • "syntax_error": {
    },
  • "trailing_comment": {
    },
  • "union_set": {
    }
}

Update the SQL Injection policy.

put/security/sqli/{group_id}/policy

To freeze the version of this endpoint, please add the following header to your requests: - Accept: application/json; version=1.0

Request
path Parameters
group_id
required
string <uuid>
Request Body schema: application/json
required
object (SQLiAlgoSettings)
required
object (SQLiAlgoSettings)
required
object (SQLiAlgoSettings)
required
object (SQLiAlgoSettings)
required
object (SQLiAlgoSettings)
required
object (SQLiAlgoSettings)
required
object (SQLiAlgoSettings)
required
object (SQLiAlgoSettings)
Responses
204

Successfully updated the file access policy.

400

Invalid algorithm for SQLi policy.

422

Unprocessable Entity

Request samples
application/json
{
  • "always_false": {
    },
  • "always_true": {
    },
  • "bad_function": {
    },
  • "http_params": {
    },
  • "stacking_queries": {
    },
  • "syntax_error": {
    },
  • "trailing_comment": {
    },
  • "union_set": {
    }
}
Response samples
application/json
{
  • "code": 0,
  • "errors": { },
  • "message": "string",
  • "status": "string"
}