Fetches the details of a Zone Lockdown rule.
/zones/{zone_identifier}/firewall/lockdowns/{id}
get
Zone Lockdown
zone-lockdown-get-a-zone-lockdown-rule
{
"business": true,
"enterprise": true,
"free": false,
"pro": true
}null[
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The unique identifier of the Zone Lockdown rule.",
"example": "372e67954025e0ba6aaa6d586b9e0b59",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "zone_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"nullable": true
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"additionalProperties": false,
"properties": {
"configurations": {
"anyOf": [
{
"properties": {
"target": {
"description": "The configuration target. You must set the target to `ip` when specifying an IP address in the Zone Lockdown rule.",
"enum": [
"ip"
],
"example": "ip"
},
"value": {
"description": "The IP address to match. This address will be compared to the IP address of incoming requests.",
"example": "198.51.100.4",
"type": "string"
}
},
"title": "An IP address configuration."
},
{
"properties": {
"target": {
"description": "The configuration target. You must set the target to `ip_range` when specifying an IP address range in the Zone Lockdown rule.",
"enum": [
"ip_range"
],
"example": "ip_range"
},
"value": {
"description": "The IP address range to match. You can only use prefix lengths `/16` and `/24`.",
"example": "198.51.100.4/16",
"type": "string"
}
},
"title": "An IP address range configuration."
}
],
"description": "A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations.",
"items": {
"anyOf": [
{
"properties": {
"target": {
"description": "The configuration target. You must set the target to `ip` when specifying an IP address in the Zone Lockdown rule.",
"enum": [
"ip"
],
"example": "ip"
},
"value": {
"description": "The IP address to match. This address will be compared to the IP address of incoming requests.",
"example": "198.51.100.4",
"type": "string"
}
},
"title": "An IP address configuration."
},
{
"properties": {
"target": {
"description": "The configuration target. You must set the target to `ip_range` when specifying an IP address range in the Zone Lockdown rule.",
"enum": [
"ip_range"
],
"example": "ip_range"
},
"value": {
"description": "The IP address range to match. You can only use prefix lengths `/16` and `/24`.",
"example": "198.51.100.4/16",
"type": "string"
}
},
"title": "An IP address range configuration."
}
]
},
"type": "array"
},
"created_on": {
"description": "The timestamp of when the rule was created.",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An informative summary of the rule.",
"example": "Restrict access to these endpoints to requests from a known IP address",
"maxLength": 1024,
"type": "string"
},
"id": {
"description": "The unique identifier of the Zone Lockdown rule.",
"example": "372e67954025e0ba6aaa6d586b9e0b59",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"modified_on": {
"description": "The timestamp of when the rule was last modified.",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"paused": {
"description": "When true, indicates that the rule is currently paused.",
"example": false,
"type": "boolean"
},
"urls": {
"description": "The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.",
"items": {
"example": "api.mysite.com/some/endpoint*",
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"created_on",
"modified_on",
"paused",
"description",
"urls",
"configurations"
]
}
},
"required": [
"result"
],
"type": "object"
}
]
}
}
},
"description": "Get a Zone Lockdown rule response"
},
"4xx": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"nullable": true
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"additionalProperties": false,
"properties": {
"configurations": {
"anyOf": [
{
"properties": {
"target": {
"description": "The configuration target. You must set the target to `ip` when specifying an IP address in the Zone Lockdown rule.",
"enum": [
"ip"
],
"example": "ip"
},
"value": {
"description": "The IP address to match. This address will be compared to the IP address of incoming requests.",
"example": "198.51.100.4",
"type": "string"
}
},
"title": "An IP address configuration."
},
{
"properties": {
"target": {
"description": "The configuration target. You must set the target to `ip_range` when specifying an IP address range in the Zone Lockdown rule.",
"enum": [
"ip_range"
],
"example": "ip_range"
},
"value": {
"description": "The IP address range to match. You can only use prefix lengths `/16` and `/24`.",
"example": "198.51.100.4/16",
"type": "string"
}
},
"title": "An IP address range configuration."
}
],
"description": "A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations.",
"items": {
"anyOf": [
{
"properties": {
"target": {
"description": "The configuration target. You must set the target to `ip` when specifying an IP address in the Zone Lockdown rule.",
"enum": [
"ip"
],
"example": "ip"
},
"value": {
"description": "The IP address to match. This address will be compared to the IP address of incoming requests.",
"example": "198.51.100.4",
"type": "string"
}
},
"title": "An IP address configuration."
},
{
"properties": {
"target": {
"description": "The configuration target. You must set the target to `ip_range` when specifying an IP address range in the Zone Lockdown rule.",
"enum": [
"ip_range"
],
"example": "ip_range"
},
"value": {
"description": "The IP address range to match. You can only use prefix lengths `/16` and `/24`.",
"example": "198.51.100.4/16",
"type": "string"
}
},
"title": "An IP address range configuration."
}
]
},
"type": "array"
},
"created_on": {
"description": "The timestamp of when the rule was created.",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An informative summary of the rule.",
"example": "Restrict access to these endpoints to requests from a known IP address",
"maxLength": 1024,
"type": "string"
},
"id": {
"description": "The unique identifier of the Zone Lockdown rule.",
"example": "372e67954025e0ba6aaa6d586b9e0b59",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"modified_on": {
"description": "The timestamp of when the rule was last modified.",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"paused": {
"description": "When true, indicates that the rule is currently paused.",
"example": false,
"type": "boolean"
},
"urls": {
"description": "The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.",
"items": {
"example": "api.mysite.com/some/endpoint*",
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"created_on",
"modified_on",
"paused",
"description",
"urls",
"configurations"
]
}
},
"required": [
"result"
],
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Get a Zone Lockdown rule response failure"
}
}[
{
"api_email": [],
"api_key": []
},
{
"api_token": []
}
]