Updates the description of a list.
/accounts/{account_identifier}/rules/lists/{list_id}
put
Lists
lists-update-a-list
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}null[
{
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"description": "The unique ID of the list.",
"example": "2c0fc9fa937b11eaa1b71c4d701ab86e",
"maxLength": 32,
"minLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"properties": {
"description": {
"description": "An informative summary of the list.",
"example": "This is a note",
"maxLength": 500,
"type": "string"
}
},
"type": "object"
}
}
},
"required": true
}{
"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"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"created_on": {
"description": "The RFC 3339 timestamp of when the list was created.",
"example": "2020-01-01T08:00:00Z",
"type": "string"
},
"description": {
"description": "An informative summary of the list.",
"example": "This is a note",
"maxLength": 500,
"type": "string"
},
"id": {
"description": "The unique ID of the list.",
"example": "2c0fc9fa937b11eaa1b71c4d701ab86e",
"maxLength": 32,
"minLength": 32,
"readOnly": true,
"type": "string"
},
"kind": {
"description": "The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).",
"enum": [
"ip",
"redirect",
"hostname",
"asn"
],
"example": "ip"
},
"modified_on": {
"description": "The RFC 3339 timestamp of when the list was last modified.",
"example": "2020-01-10T14:00:00Z",
"type": "string"
},
"name": {
"description": "An informative name for the list. Use this name in filter and rule expressions.",
"example": "list1",
"maxLength": 50,
"pattern": "^[a-zA-Z0-9_]+$",
"type": "string"
},
"num_items": {
"description": "The number of items in the list.",
"example": 10,
"type": "number"
},
"num_referencing_filters": {
"description": "The number of [filters](#filters) referencing the list.",
"example": 2,
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
}
],
"type": "object"
}
}
},
"description": "Update a list 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"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"created_on": {
"description": "The RFC 3339 timestamp of when the list was created.",
"example": "2020-01-01T08:00:00Z",
"type": "string"
},
"description": {
"description": "An informative summary of the list.",
"example": "This is a note",
"maxLength": 500,
"type": "string"
},
"id": {
"description": "The unique ID of the list.",
"example": "2c0fc9fa937b11eaa1b71c4d701ab86e",
"maxLength": 32,
"minLength": 32,
"readOnly": true,
"type": "string"
},
"kind": {
"description": "The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).",
"enum": [
"ip",
"redirect",
"hostname",
"asn"
],
"example": "ip"
},
"modified_on": {
"description": "The RFC 3339 timestamp of when the list was last modified.",
"example": "2020-01-10T14:00:00Z",
"type": "string"
},
"name": {
"description": "An informative name for the list. Use this name in filter and rule expressions.",
"example": "list1",
"maxLength": 50,
"pattern": "^[a-zA-Z0-9_]+$",
"type": "string"
},
"num_items": {
"description": "The number of items in the list.",
"example": 10,
"type": "number"
},
"num_referencing_filters": {
"description": "The number of [filters](#filters) referencing the list.",
"example": 2,
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
}
],
"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": "Update a list response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]