Create a custom list | HUMAN Documentation

curl -X POST https://console.humansecurity.com/api/v1/botDefender/customLists \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Suspicious Users Blocklist"
}'

{
  "message": "success",
  "result": true,
  "content": {
    "_id": "64f8b12345678901234567ab",
    "account_id": "642be969c2186cae012347b8",
    "name": "Suspicious Users Blocklist",
    "status": "active",
    "created_by": "admin@humansecurity.com",
    "created_at": "2023-09-01T10:00:00Z",
    "updated_at": "2023-09-01T15:30:00Z",
    "updated_by": "admin@humansecurity.com",
    "size": 150,
    "description": "List of users flagged for suspicious activity",
    "usedBy": [
      {
        "rule_id": "d668491a-f8f8-4b92-a280-c437b4411e0e",
        "name": "Blocklist Rule",
        "status": "active"
      }
    ],
    "last_inserted_time": "2023-09-01T14:00:00Z"
  }
}

Create a new custom list.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringRequired>=1 character

Name of the custom list

descriptionstringOptional

Optional description of the custom list

Response

Custom list created successfully

messagestring

Response message

resultboolean

Indicates if the request was successful

contentobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error