Fetches all rulesets at the account level.
/accounts/{account_id}/rulesets
get
Account Rulesets
listAccountRulesets
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}null[
{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"description": "The unique ID of the account.",
"example": "abf9b32d38c5f572afde3336ec0ce302",
"pattern": "^[0-9a-f]{32}$",
"title": "ID",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "A response object.",
"properties": {
"errors": {
"allOf": [
{
"description": "A list of error messages.",
"items": {
"description": "A message.",
"properties": {
"code": {
"description": "A unique code for this message.",
"example": 10000,
"title": "Code",
"type": "integer"
},
"message": {
"description": "A text description of this message.",
"example": "something bad happened",
"minLength": 1,
"title": "Description",
"type": "string"
},
"source": {
"description": "The source of this message.",
"properties": {
"pointer": {
"description": "A JSON pointer to the field that is the source of the message.",
"example": "/rules/0/action",
"minLength": 1,
"title": "Pointer",
"type": "string"
}
},
"required": [
"pointer"
],
"title": "Source",
"type": "object"
}
},
"required": [
"message"
],
"title": "Message",
"type": "object"
},
"title": "Errors",
"type": "array"
},
{
"enum": [
[]
]
}
]
},
"messages": {
"description": "A list of warning messages.",
"items": {
"description": "A message.",
"properties": {
"code": {
"description": "A unique code for this message.",
"example": 10000,
"title": "Code",
"type": "integer"
},
"message": {
"description": "A text description of this message.",
"example": "something bad happened",
"minLength": 1,
"title": "Description",
"type": "string"
},
"source": {
"description": "The source of this message.",
"properties": {
"pointer": {
"description": "A JSON pointer to the field that is the source of the message.",
"example": "/rules/0/action",
"minLength": 1,
"title": "Pointer",
"type": "string"
}
},
"required": [
"pointer"
],
"title": "Source",
"type": "object"
}
},
"required": [
"message"
],
"title": "Message",
"type": "object"
},
"title": "Messages",
"type": "array"
},
"result": {
"description": "A result.",
"title": "Result"
},
"success": {
"description": "Whether the API call was successful.",
"enum": [
true
],
"title": "Success",
"type": "boolean"
}
},
"required": [
"result",
"success",
"errors",
"messages"
],
"title": "Response",
"type": "object"
},
{
"properties": {
"result": {
"description": "A list of rulesets. The returned information will not include the rules in each ruleset.",
"items": {
"allOf": [
{
"description": "A ruleset object.",
"properties": {
"description": {
"default": "",
"description": "An informative description of the ruleset.",
"example": "My ruleset to execute managed rulesets",
"title": "Description",
"type": "string"
},
"id": {
"allOf": [
{
"description": "The unique ID of the ruleset.",
"example": "2f2feab2026849078ba485f918791bdc",
"pattern": "^[0-9a-f]{32}$",
"title": "ID",
"type": "string"
},
{
"readOnly": true
}
]
},
"kind": {
"description": "The kind of the ruleset.",
"enum": [
"managed",
"custom",
"root",
"zone"
],
"example": "root",
"title": "Kind",
"type": "string"
},
"last_updated": {
"description": "The timestamp of when the ruleset was last modified.",
"example": "2000-01-01T00:00:00.000000Z",
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"description": "The human-readable name of the ruleset.",
"example": "My ruleset",
"minLength": 1,
"title": "Name",
"type": "string"
},
"phase": {
"description": "The phase of the ruleset.",
"enum": [
"ddos_l4",
"ddos_l7",
"http_config_settings",
"http_custom_errors",
"http_log_custom_fields",
"http_ratelimit",
"http_request_cache_settings",
"http_request_dynamic_redirect",
"http_request_firewall_custom",
"http_request_firewall_managed",
"http_request_late_transform",
"http_request_origin",
"http_request_redirect",
"http_request_sanitize",
"http_request_sbfm",
"http_request_select_configuration",
"http_request_transform",
"http_response_compression",
"http_response_firewall_managed",
"http_response_headers_transform",
"magic_transit",
"magic_transit_ids_managed",
"magic_transit_managed"
],
"example": "http_request_firewall_custom",
"title": "Phase",
"type": "string"
},
"version": {
"description": "The version of the ruleset.",
"example": "1",
"pattern": "^[0-9]+$",
"readOnly": true,
"title": "Version",
"type": "string"
}
},
"required": [
"id",
"version",
"last_updated"
],
"title": "Ruleset",
"type": "object"
},
{
"required": [
"name",
"kind",
"phase"
]
}
]
},
"title": "Rulesets",
"type": "array"
}
}
}
]
}
}
},
"description": "List account rulesets response."
},
"4XX": {
"content": {
"application/json": {
"schema": {
"description": "A failure response object.",
"properties": {
"errors": {
"description": "A list of error messages.",
"items": {
"description": "A message.",
"properties": {
"code": {
"description": "A unique code for this message.",
"example": 10000,
"title": "Code",
"type": "integer"
},
"message": {
"description": "A text description of this message.",
"example": "something bad happened",
"minLength": 1,
"title": "Description",
"type": "string"
},
"source": {
"description": "The source of this message.",
"properties": {
"pointer": {
"description": "A JSON pointer to the field that is the source of the message.",
"example": "/rules/0/action",
"minLength": 1,
"title": "Pointer",
"type": "string"
}
},
"required": [
"pointer"
],
"title": "Source",
"type": "object"
}
},
"required": [
"message"
],
"title": "Message",
"type": "object"
},
"title": "Errors",
"type": "array"
},
"messages": {
"description": "A list of warning messages.",
"items": {
"description": "A message.",
"properties": {
"code": {
"description": "A unique code for this message.",
"example": 10000,
"title": "Code",
"type": "integer"
},
"message": {
"description": "A text description of this message.",
"example": "something bad happened",
"minLength": 1,
"title": "Description",
"type": "string"
},
"source": {
"description": "The source of this message.",
"properties": {
"pointer": {
"description": "A JSON pointer to the field that is the source of the message.",
"example": "/rules/0/action",
"minLength": 1,
"title": "Pointer",
"type": "string"
}
},
"required": [
"pointer"
],
"title": "Source",
"type": "object"
}
},
"required": [
"message"
],
"title": "Message",
"type": "object"
},
"title": "Messages",
"type": "array"
},
"result": {
"description": "A result.",
"enum": [
null
],
"title": "Result"
},
"success": {
"description": "Whether the API call was successful.",
"enum": [
false
],
"title": "Success",
"type": "boolean"
}
},
"required": [
"result",
"success",
"errors",
"messages"
],
"title": "Failure response",
"type": "object"
}
}
},
"description": "List account rulesets failure response."
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
},
{
"api_email": [],
"api_key": []
}
]