PAGES

← Castle

Castle — API

Castle APIv1 Read the vendor's spec ↗

  • 27 endpoints
  • 2 deprecated
  • 3 versions archived since Aug 2, 2026
  • Last checked Nov 2, 2026

Castle APIs uses standard HTTP response codes, authentication and verbs.

Get started

first call
$ curl "https://api.castle.io/v1/lists" \
  -u "$USERNAME:$PASSWORD"

Set $USERNAME and $PASSWORD first, then paste.

Base URL
https://api.castle.io/v1
Authenticate
HTTP basic: username and password API keys are used to authenticate all Castle APIs.

What it covers

  • List Items 8 List Items represents entries in a List.
  • Lists 6 Lists represents a generic collection of items, such as Users, IPs, Transactions or any custom property.
  • Privacy 4 APIs intended to help adhere to GDPR Compliance and specifically assist in supporting Article 15: Right of access by the data subject and Article 17: Right to be forgotten.
  • Events 3 Castle Events APIs allow you to query and aggregate Events that have been sent to the Castle Risk Assessment APIs.
  • IP Downloads 2 Download Castle's IP datasets.
  • IP Lookups 2 Look up Castle's IP intelligence data (address metadata + tunnel observations) for a single IP or a batch.
  • Risk Assessment 2 Castle Risk Assessment APIs will calculate a risk score as well as evaluate policies based on the provided payload.

Endpoints

27 of 27

Open an endpoint for a runnable command, its inputs and what it returns.

List Items 8

  • DELETE /lists/{list_id}/items/{id}/archive Archive a List Item

    Loading…

  • GET /lists/{list_id}/items/{id} Fetch a List Item by ID

    Loading…

  • POST /lists/{list_id}/items Create a new List Item

    Loading…

  • POST /lists/{list_id}/items/batch Create or update multiple List Items

    Loading…

  • POST /lists/{list_id}/items/count Count List Items

    Loading…

  • POST /lists/{list_id}/items/query Search List Items

    Loading…

  • PUT /lists/{list_id}/items/{id} Update a List Item

    Loading…

  • PUT /lists/{list_id}/items/{id}/unarchive Unarchive a List Item

    Loading…

Lists 6

  • DELETE /lists/{id} Delete List

    Loading…

  • GET /lists List all Lists

    Loading…

  • GET /lists/{id} Return a List by ID

    Loading…

  • POST /lists Create a new List

    Loading…

  • POST /lists/query Search Lists

    Loading…

  • PUT /lists/{id} Update a List

    Loading…

Privacy 4

  • DELETE /privacy/users Delete User Data

    Loading…

  • DELETE /privacy/users/{id} Delete User Data deprecated

    Loading…

  • POST /privacy/users Request User Data

    Loading…

  • POST /privacy/users/{id} Request User Data deprecated

    Loading…

Events 3

  • GET /events/schema Get Events Schema

    Loading…

  • POST /events/group Group Events

    Loading…

  • POST /events/query Search Events

    Loading…

IP Downloads 2

  • GET /ips/downloads/{dataset}/{window}.{format}.gz IP Dataset Download

    Loading…

  • HEAD /ips/downloads/{dataset}/{window}.{format}.gz IP Dataset Download metadata

    Loading…

IP Lookups 2

  • GET /ips/{value} Look up a single IP

    Loading…

  • POST /ips/query Look up IPs in a batch

    Loading…

Risk Assessment 2

  • POST /filter Filter

    Loading…

  • POST /risk Risk

    Loading…

Change log

    • +GET /ips/downloads/{dataset}/{window}.{format}.gz
    • +HEAD /ips/downloads/{dataset}/{window}.{format}.gz
browse all tools → score card for your toolchain →