Skip to main content
API docs by Redocly

RBLTracker API (3.0)

RBLTracker Support: support@rbltracker.com Terms of Service

The RBLTracker API is a simple web-service API, which lets customers poll our system for the current list of Hosts, Contacts, and listed Hosts, as well as manage your Hosts and Contacts.

PHP SDK

The PHP SDK can be installed via composer:

composer require rbltracker/sdk

Or the source code can be downloaded directly from the GitHub repository.

The PHP SDK requires:

  • PHP >= 5.4
  • The PHP JSON extension

Node.js SDK

The Node.js SDK can be installed via npm:

npm install rbltracker

Or the source code can be downloaded directly from the GitHub repository.

Python SDK

The Python SDK can be installed via pip:

pip install rbltracker

Or the source code can be downloaded directly from the GitHub repository.

The Python SDK supports Python version 2.6 / 2.7 / 3.2 / 3.3.

Manual Check

These features let you start a manual, real-time check against a Host value on your account, or to a one-off IP address or domain.

Start Check

Starts a manual check for a provided Host.

This process is asynchronous, in that it returns right away, returning a check id that you may use to poll for subsequent updates. This is done because a full RBL check may take some time to process, and this avoids blocking the API response.

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
host
required
string

The host value; either an IP address, domain name, or host SID (to use an existing host).

callback
string <uri>

An HTTP callback URL that we will post to once the check request completes.

details
integer
Default: 0
Enum: 0 1

A flag indicating if the RBL details should be returned with the response. Either 1 or 0 defaults to 0.

Responses

Callbacks

Request samples 

curl https://api.rbltracker.com/3.0/check/start.json \
    -u 'your_account_sid:your_auth_token' \
    -d host='10.10.10.11' \
    -d callback='https://your.website.com/callback.php' \
    -d details=1

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "data": {
    }
}

Callback payload samples

Callback
POST: {$request.body#/callback}
Content type
application/json
{
  • "event_sid": "EV9dbf5e2f7e924418a6d6b483a584adcf",
  • "event_type": "rbl.host.check.completed",
  • "event_date": "2025-12-22T23:43:52+00:00",
  • "check_sid": "PPf93d71a4a9892defde3ce995b141391dbbb95dcb000279fe51f4191f8bf41e1a",
  • "host": {
    },
  • "listed": true,
  • "total": 1,
  • "details": [
    ]
}

Check Status

Gets the status of a previously started manual check.

You can use the check id returned from /3.0/check/start to poll for check status in real-time.

Authorizations:
basicAuth
query Parameters
id
required
string^PP[0-9a-fA-F]{64}$
Example: id=PPf93d71a4a9892defde3ce995b141391dbbb95dcb000279fe51f4191f8bf41e1a

Check id returned from /check/start.

details
integer
Default: 0
Enum: 0 1

A flag indicating if the RBL details should be returned with the response. Either 1 or 0 defaults to 0.

Responses

Request samples 

curl -G https://api.rbltracker.com/3.0/check/status/{id}.json?details=1 \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "data": {
    }
}

Listings

Returns a list of all the Hosts that are currently listed on one or more RBLs.

Listings

Return a full list of all the hosts that are currently listed on one or more data sources.

This data mirrors the response returned by the /3.0/hosts API request. The only difference, is the /3.0/listings request only returns hosts that are currently listed, instead of all hosts.

Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1

The current page number.

page_size
integer >= 1
Default: 20

Entries per page.

Responses

Request samples 

curl -G https://api.rbltracker.com/3.0/listings.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "page": 1,
  • "total_pages": 1,
  • "page_size": 20,
  • "total_hosts": 1,
  • "total_listed": 1,
  • "data": [
    ]
}

Hosts

Returns a list of all Hosts configured on your account.

Get a List of Hosts

Returns a full list of Hosts on your account.

Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1

The current page number.

page_size
integer >= 1
Default: 20

Entries per page.

Responses

Request samples 

curl -G https://api.rbltracker.com/3.0/hosts.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "page": 1,
  • "total_pages": 1,
  • "page_size": 20,
  • "total_hosts": 1,
  • "total_listed": 1,
  • "data": [
    ]
}

Get Host

Returns details for an individual host

Authorizations:
basicAuth
path Parameters
id
required
string^HT[0-9a-fA-F]{32}$
Example: HTee06c4fa7c23aa8a3a4e8d66922b0834

Unique Host SID.

Responses

Request samples 

curl -G https://api.rbltracker.com/3.0/host/{id}.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "page": 1,
  • "total_pages": 1,
  • "page_size": 20,
  • "total_hosts": 1,
  • "total_listed": 1,
  • "data": [
    ]
}

Add Host

Add a new host to your account.

When using the ip_range host type, or when adding hosts by subnet, multiple hosts may be added, and returned in the data response object.

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
host
required
string

Host value (IP/domain/subnet) based on type.

name
required
string

Label for the Host.

type
required
string
Enum: "rbl " "uribl" "ip_range"

Host type

rbl_profile
string^RP[0-9a-fA-F]{32}$

Monitoring Profile id to use on this Host.

contact_group
string^CG[0-9a-fA-F]{32}$

Contact Group id to use.

Responses

Request samples 

curl https://api.rbltracker.com/3.0/host/add.json \
    -u 'your_account_sid:your_auth_token' \
    -d name='My New Host' \
    -d host='10.10.10.11' \
    -d type='rbl' \
    -d rbl_profile='RP15d4e891d784977cacbfcbb00c48f133' \
    -d contact_group='CG37106c6baa1ec90a2b3f5c8ec54afe9d'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "data": [
    ]
}

Modify Host

Modifies an existing host on your account.

Authorizations:
basicAuth
path Parameters
id
required
string^HT[0-9a-fA-F]{32}$
Example: HTee06c4fa7c23aa8a3a4e8d66922b0834

Unique Host SID.

Request Body schema: application/x-www-form-urlencoded
optional
name
string

The label for this Host.

rbl_profile
string^RP[0-9a-fA-F]{32}$

The unique SID of the Monitoring Profile to use for this Host.

contact_group
string

A comma separated list of one or more Contact Group SIDs to use for this Host.

Responses

Request samples 

curl https://api.rbltracker.com/3.0/host/update/{id}.json \
    -u 'your_account_sid:your_auth_token' \
    -d name='My New Host'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Pause Host

Pauses a Host, which temporarily stops all checks on this Host.

Authorizations:
basicAuth
path Parameters
id
required
string^HT[0-9a-fA-F]{32}$
Example: HTee06c4fa7c23aa8a3a4e8d66922b0834

Unique Host SID.

Responses

Request samples 

curl -X POST https://api.rbltracker.com/3.0/host/pause/{id}.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Re-Activate Host

Re-activates a Host after it was paused. We will resume processing checks on this host.

Authorizations:
basicAuth
path Parameters
id
required
string^HT[0-9a-fA-F]{32}$
Example: HTee06c4fa7c23aa8a3a4e8d66922b0834

Unique Host SID.

Responses

Request samples 

curl -X POST https://api.rbltracker.com/3.0/host/resume/{id}.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Delete Host

Deletes an existing host on your account.

Authorizations:
basicAuth
path Parameters
id
required
string^HT[0-9a-fA-F]{32}$
Example: HTee06c4fa7c23aa8a3a4e8d66922b0834

Unique Host SID.

Responses

Request samples 

curl -X POST https://api.rbltracker.com/3.0/host/delete/{id}.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Monitoring Profiles

Returns a list of all Monitoring Profiles configured on your account.

Note: These features are only available to customers on a paid plan.

Get a List of Monitoring Profiles

Returns a full list of RBL profiles on your account.

Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1

The current page number.

page_size
integer >= 1
Default: 20

Entries per page.

Responses

Request samples 

curl -G https://api.rbltracker.com/3.0/rblprofiles.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "page": 1,
  • "total_pages": 1,
  • "page_size": 20,
  • "total_rbl_profiles": 1,
  • "data": [
    ]
}

Get Monitoring Profile

Return details for a single Monitoring Profile.

Authorizations:
basicAuth
path Parameters
id
required
string^RP[0-9a-fA-F]{32}$
Example: RP15d4e891d784977cacbfcbb00c48f133

The unique SID of the Monitoring Profile.

Responses

Request samples 

curl -G https://api.rbltracker.com/3.0/rblprofile/{id}.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "page": 1,
  • "total_pages": 1,
  • "page_size": 20,
  • "total_rbl_profiles": 1,
  • "data": [
    ]
}

Add Monitoring Profile

Add a new RBL profile to your account.

If the entries values omitted completely, then all the active default RBLs will be selected for this new profile. If the entries list is provided, but left empty, then no RBLs will be added to this profile.

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
name
required
string

A label to use for this new profile.

is_default
integer
Enum: 0 1

If this profile should be marked as default.

entries
string

A comma separated list of RBL SIDs to use for this new profile.

If not provided, the Montioring Profile will be configured to use our default set of data sources.

Responses

Request samples 

curl https://api.rbltracker.com/3.0/rblprofile/add.json \
    -u 'your_account_sid:your_auth_token" \
    -d name="My RBL Profile" \
    -d is_default="1" \
    -d entries="RBdbf3e492680ee6358a1a703d8b275aa7,RBdb2c27a6f53401a6f64a939f74458fb0"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "data": {
    }
}

Modify Monitoring Profile

Modify an existing RBL profile.

Authorizations:
basicAuth
path Parameters
id
required
string^RP[0-9a-fA-F]{32}$
Example: RP15d4e891d784977cacbfcbb00c48f133

The unique SID of the Monitoring Profile.

Request Body schema: application/x-www-form-urlencoded
optional
name
string

A label to use for this new profile.

is_default
integer
Enum: 0 1

If this profile should be marked as default.

entries
string

A comma separated list of RBL SIDs to use for this new profile.

Responses

Request samples 

curl https://api.rbltracker.com/3.0/rblprofile/update/{id}.json \
    -u 'your_account_sid:your_auth_token" \
    -d name="My RBL Profile" \
    -d is_default="1" \
    -d entries="RBdbf3e492680ee6358a1a703d8b275aa7,RBdb2c27a6f53401a6f64a939f74458fb0"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Delete Monitoring Profile

Delete an existing RBL profile.

If the default RBL profile is deleted, then another RBL profile will be chosen at random to become the default RBL profile.

You may not delete an RBL profile that is currently associated with a host, and you may not delete the last RBL profile. You must always have at least one.

Authorizations:
basicAuth
path Parameters
id
required
string^RP[0-9a-fA-F]{32}$
Example: RP15d4e891d784977cacbfcbb00c48f133

The unique SID of the Monitoring Profile.

Responses

Request samples 

curl -X POST https://api.rbltracker.com/3.0/rblprofile/delete/{id}.json \
    -u 'your_account_sid:your_auth_token"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

RBLs

Returns a list of all the active RBLs on the system, including custom RBLs that you've added.

Note: These features are only available to customers on a paid plan.

Get a List of RBLs

Return a full list of all the active RBLs on the system, including custom RBLs that you’ve added.

The custom RBL feature lets you add custom RBLs and URIBLs to your account, that we does not normally check. You can only add rbl and uribl types.

RBLs with the custom attribute set to 1 is a custom RBL that you’ve added. These custom RBLs can be managed via the API. System RBLs (where custom is set to 0) cannot be modified, and are effectively read-only RBLs.

Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1

The current page number.

page_size
integer >= 1
Default: 20

Entries per page.

Responses

Request samples 

curl -G https://api.rbltracker.com/3.0/rbls.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "page": 1,
  • "total_pages": 1,
  • "page_size": 20,
  • "total_rbls": 10,
  • "data": []
}

Get RBL

Returns the details for a single RBL.

Authorizations:
basicAuth
path Parameters
id
required
string^RB[0-9a-fA-F]{32}$
Example: RB18c470cc518a09678bb280960dbdd524

The unique SID of the Custom RBL.

Responses

Request samples 

curl -G https://api.rbltracker.com/3.0/rbl/{id}.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "page": 1,
  • "total_pages": 1,
  • "page_size": 20,
  • "total_rbls": 1,
  • "data": []
}

Add Custom RBL

Adds a new custom RBL to your account.

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
type
required
string
Enum: "rbl" "uribl"

The type of RBL

host
required
string

Hostname of the RBL.

Responses

Request samples 

curl https://api.rbltracker.com/3.0/rbl/add.json \
    -u "your_account_sid:your_auth_token" \
    -d type="rbl" \
    -d host="your.custom.rbl.com"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "data": {
    }
}

Modify Custom RBL

Modifies a custom RBL on your account.

Authorizations:
basicAuth
path Parameters
id
required
string^RB[0-9a-fA-F]{32}$
Example: RB18c470cc518a09678bb280960dbdd524

The unique SID of the Custom RBL.

Request Body schema: application/x-www-form-urlencoded
optional
type
string
Enum: "rbl" "uribl"

The type of RBL

host
string

Hostname of the RBL.

Responses

Request samples 

curl https://api.rbltracker.com/3.0/rbl/update/{id}.json \
    -u "your_account_sid:your_auth_token" \
    -d type="rbl" \
    -d host="your.custom.rbl.com"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Pause Custom RBL

Pauses a custom RBL entry. This temporarily stops checks using this custom RBL.

You may only pause custom RBLs- RBLs where the custom attribute is 1.

Authorizations:
basicAuth
path Parameters
id
required
string^RB[0-9a-fA-F]{32}$
Example: RB18c470cc518a09678bb280960dbdd524

The unique SID of the Custom RBL.

Responses

Request samples 

curl -X POST https://api.rbltracker.com/3.0/rbl/pause/{id}.json \
    -u "your_account_sid:your_auth_token"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Re-Activate Custom RBL

Re-activates a custom RBL that was previously paused. We will resume using this RBL for checks.

You may only re-activate custom RBLs- RBLs where the custom attribute is 1.

Authorizations:
basicAuth
path Parameters
id
required
string^RB[0-9a-fA-F]{32}$
Example: RB18c470cc518a09678bb280960dbdd524

The unique SID of the Custom RBL.

Responses

Request samples 

curl -X POST https://api.rbltracker.com/3.0/rbl/resume/{id}.json \
    -u "your_account_sid:your_auth_token"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Delete Custom RBL

Delete a custom RBL from your account.

You may only delete custom RBLs- RBLs where the custom attribute is 1.

Authorizations:
basicAuth
path Parameters
id
required
string^RB[0-9a-fA-F]{32}$
Example: RB18c470cc518a09678bb280960dbdd524

The unique SID of the Custom RBL.

Responses

Request samples 

curl -X POST https://api.rbltracker.com/3.0/rbl/delete/{id}.json \
    -u "your_account_sid:your_auth_token"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Contacts

Returns a list of all Contacts configured on your account.

Get a List of Contacts

Returns a full list of contacts on your account.

Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1

The current page number.

page_size
integer >= 1
Default: 20

Entries per page.

Responses

Request samples 

curl -G https://api.rbltracker.com/3.0/contacts.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "page": 1,
  • "total_pages": 1,
  • "page_size": 20,
  • "total_contacts": 10,
  • "data": [
    ]
}

Get Contact

Returns the details for a single contact.

Authorizations:
basicAuth
path Parameters
id
required
string^CO[0-9a-fA-F]{32}$
Example: COc7d69f48da351273d71d431c3402a091

The unique SID of the Contact.

Responses

Request samples 

curl -G https://api.rbltracker.com/3.0/contact/{id}.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "page": 1,
  • "total_pages": 1,
  • "page_size": 20,
  • "total_contacts": 1,
  • "data": [
    ]
}

Add Contact

Adds a new contact to your account.

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
contact
required
string

The contact value (based on the type).

type
required
string
Enum: "email" "sms" "pushover" "pagerduty" "slack" "datadog" "discord" "telegram" "endpoint" "aws-sns" "aws-cloudwatch"

The contact type.

schedule
required
string
Enum: "every_check" "start_and_end" "while_listed"

The contact schedule.

contact_group
string

A comma separated list of one or more Contact Groups SIDs to associated this Contact with.

Responses

Request samples 

curl https://api.rbltracker.com/3.0/contact/add.json \
    -u "your_account_sid:your_auth_token" \
    -d contact="info@rbltracker.com" \
    -d type="email" \
    -d schedule="every_check" \
    -d contact_group="CGd3dca251d33135e0a518d7c49b89dc61"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "data": {
    }
}

Modify Contact

Modifies an existing contact.

Authorizations:
basicAuth
path Parameters
id
required
string^CO[0-9a-fA-F]{32}$
Example: COc7d69f48da351273d71d431c3402a091

The unique SID of the Contact.

Request Body schema: application/x-www-form-urlencoded
optional
schedule
string
Enum: "every_check" "start_and_end" "while_listed"

The contact schedule.

contact_group
string

A comma separated list of one or more Contact Groups SIDs to associated this Contact with.

Responses

Request samples 

curl https://api.rbltracker.com/3.0/contact/update/{id}.json \
    -u "your_account_sid:your_auth_token" \
    -d schedule="every_check" \
    -d contact_group="CGd3dca251d33135e0a518d7c49b89dc61"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Pause Contact

Pause a contact. This will temporarily stop notifications to this contact.

Authorizations:
basicAuth
path Parameters
id
required
string^CO[0-9a-fA-F]{32}$
Example: COd3dca251d33135e0a518d7c49b89dc61

The unique SID of the Contact.

Responses

Request samples 

curl -X POST https://api.rbltracker.com/3.0/contact/pause/{id}.json \
    -u "your_account_sid:your_auth_token"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Re-Activate Contact

Re-activate a contact after it was paused. We will resume sending notifications to this contact.

Authorizations:
basicAuth
path Parameters
id
required
string^CO[0-9a-fA-F]{32}$
Example: COd3dca251d33135e0a518d7c49b89dc61

The unique SID of the Contact.

Responses

Request samples 

curl -X POST https://api.rbltracker.com/3.0/contact/resume/{id}.json \
    -u "your_account_sid:your_auth_token"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Resend Confirmation

Authorizations:
basicAuth
path Parameters
id
required
string^CO[0-9a-fA-F]{32}$
Example: COd3dca251d33135e0a518d7c49b89dc61

The unique SID of the Contact.

Responses

Request samples 

curl -X POST https://api.rbltracker.com/3.0/contact/resend/{id}.json \
    -u "your_account_sid:your_auth_token"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Confirm Contact

Confirms a pending contact using a confirmation code.

Authorizations:
basicAuth
path Parameters
id
required
string^CO[0-9a-fA-F]{32}$
Example: COc7d69f48da351273d71d431c3402a091

The unique SID of the Contact.

Request Body schema: application/x-www-form-urlencoded
required
authcode
required
string

Confirmation token delivered to the Contact.

Responses

Request samples 

curl https://api.rbltracker.com/3.0/contact/confirm/{id}.json \
    -d authcode="3Kx3se" \
    -u "your_account_sid:your_auth_token"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Delete Contact

Authorizations:
basicAuth
path Parameters
id
required
string^CO[0-9a-fA-F]{32}$
Example: COc7d69f48da351273d71d431c3402a091

The unique SID of the Contact.

Responses

Request samples 

curl -X POST https://api.rbltracker.com/3.0/contact/delete/{id}.json \
    -u "your_account_sid:your_auth_token"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Contact Groups

Returns a list of all Contact Groups configured on your account.

Get a List of Contact Groups

Returns a full list of contact groups on your account.

The is_default flag defines which contact group is marked as default. The default contact group is used on new hosts and contacts when a contact group ID is omitted.

Only one contact group can be marked a default. If you add a new contact group, or update an existing contact group, and set is_default to 1, then any existing default contact group will no longer be set as default.

Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1

The current page number.

page_size
integer >= 1
Default: 20

Entries per page.

Responses

Request samples 

curl -G https://api.rbltracker.com/3.0/contactgroups.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "page": 1,
  • "total_pages": 1,
  • "page_size": 20,
  • "total_contact_groups": 1,
  • "data": [
    ]
}

Get Contact Group

Return details for a single Contact Group, based on the SID passed.

Authorizations:
basicAuth
path Parameters
id
required
string^CG[0-9a-fA-F]{32}$
Example: CGd3dca251d33135e0a518d7c49b89dc61

The unique SID of the Contact Group.

Responses

Request samples 

curl -G https://api.rbltracker.com/3.0/contactgroup/{id}.json \
    -u 'your_account_sid:your_auth_token'

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "page": 1,
  • "total_pages": 1,
  • "page_size": 20,
  • "total_contact_groups": 1,
  • "data": [
    ]
}

Add Contact Group

Add a new contact group to your account.

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
name
required
string

The label of the new Contact Group.

is_default
integer
Enum: 0 1

Mark this group as the default Contact Group

Responses

Request samples 

curl https://api.rbltracker.com/3.0/contactgroup/add.json \
    -u 'your_account_sid:your_auth_token" \
    -d name="My Contact Group" \
    -d is_default="1"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6",
  • "data": {
    }
}

Modify Contact Group

Modify an existing contact group.

Authorizations:
basicAuth
path Parameters
id
required
string^CG[0-9a-fA-F]{32}$
Example: CGd3dca251d33135e0a518d7c49b89dc61

The unique SID of the Contact Group.

Request Body schema: application/x-www-form-urlencoded
optional
name
string

The label for this Contact Group.

is_default
integer
Enum: 0 1

Mark this group as the default Contact Group

Responses

Request samples 

curl https://api.rbltracker.com/3.0/contactgroup/update/{id}.json \
    -u 'your_account_sid:your_auth_token" \
    -d name="My Contact Group" \
    -d is_default="1"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

Delete Contact Group

Delete an existing contact group.

If the default contact group is deleted, then another contact group will be chosen at random to become the default Contact Group.

You may not delete a Contact Group that is currently associated with a Contact or a Host, and you may not delete the last Contact Group; you must always have at least one.

Authorizations:
basicAuth
path Parameters
id
required
string^CG[0-9a-fA-F]{32}$
Example: CGd3dca251d33135e0a518d7c49b89dc61

The unique SID of the Contact Group.

Responses

Request samples 

curl -X POST https://api.rbltracker.com/3.0/contactgroup/delete/{id}.json \
    -u 'your_account_sid:your_auth_token"

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "status_message": "OK",
  • "version": "3.6"
}

RBL Events

Events triggered during RBL Monitoring checks.

Host Check Started Webhook

Triggered at the start of a check, when one of your hosts is checked.

Request Body schema: application/json
event_sid
required
string^EV[0-9a-fA-F]{32}$

The unique SID of the event.

event_type
required
string

The event type indicator.

event_date
required
string <date-time>

The date the event was triggered in GMT.

check_sid
required
string^PP[0-9a-fA-F]{64}$

The unique SID of the check request.

required
object

A standard Host object.

Responses

Request samples

Content type
application/json
{
  • "event_sid": "EV67bca97cf42743beac24264790faf6dd",
  • "event_type": "rbl.host.check.started",
  • "event_date": "2025-12-29T18:30:27+00:00",
  • "check_sid": "PPf93d71a4a9892defde3ce995b141391dbbb95dcb000279fe51f4191f8bf41e1a",
  • "host": {
    }
}

Host Check Completed Webhook

Triggered at the end of a check, when one of your hosts is checked. This event is trigger whether or not the host is listed.

Request Body schema: application/json
event_sid
required
string^EV[0-9a-fA-F]{32}$

The unique SID of the event.

event_type
required
string

The event type indicator.

event_date
required
string <date-time>

The date the event was triggered in GMT.

check_sid
required
string^PP[0-9a-fA-F]{64}$

The unique SID of the check request.

required
object

A standard Host object.

listed
required
boolean

If the Host is listed or not.

total
required
integer
Default: 0

The total number of data sources this Host is currently listed on.

required
Array of objects (webhook_rbl_details)

An array of data sources that matched this Host. This can be empty if there were no matches.

Responses

Request samples

Content type
application/json
{
  • "event_sid": "EV67bca97cf42743beac24264790faf6dd",
  • "event_type": "rbl.host.check.completed",
  • "event_date": "2025-12-29T18:30:27+00:00",
  • "check_sid": "PPf93d71a4a9892defde3ce995b141391dbbb95dcb000279fe51f4191f8bf41e1a",
  • "host": {
    },
  • "listed": true,
  • "total": 1,
  • "details": [
    ]
}

Host Listed Webhook

Triggered at the end of a check, when one of your hosts is listed. This event is only triggered in the event the host is listed.

Request Body schema: application/json
event_sid
required
string^EV[0-9a-fA-F]{32}$

The unique SID of the event.

event_type
required
string

The event type indicator.

event_date
required
string <date-time>

The date the event was triggered in GMT.

check_sid
required
string^PP[0-9a-fA-F]{64}$

The unique SID of the check request.

required
object

A standard Host object.

listed
required
boolean

If the Host is listed or not. This will always be true for this event.

total
required
integer
Default: 0

The total number of data sources this Host is currently listed on.

required
Array of objects (webhook_rbl_details)

An array of data sources that matched this Host. This can be empty if there were no matches.

Responses

Request samples

Content type
application/json
{
  • "event_sid": "EV67bca97cf42743beac24264790faf6dd",
  • "event_type": "rbl.host.listed",
  • "event_date": "2025-12-29T18:30:27+00:00",
  • "check_sid": "PPf93d71a4a9892defde3ce995b141391dbbb95dcb000279fe51f4191f8bf41e1a",
  • "host": {
    },
  • "listed": true,
  • "total": 1,
  • "details": [
    ]
}

Host De-Listed Webhook

Triggered at the end of a check, when one of your hosts is de-listed. This event will only trigger in the event the host is de-listed.

Request Body schema: application/json
event_sid
required
string^EV[0-9a-fA-F]{32}$

The unique SID of the event.

event_type
required
string

The event type indicator.

event_date
required
string <date-time>

The date the event was triggered in GMT.

check_sid
required
string^PP[0-9a-fA-F]{64}$

The unique SID of the check request.

required
object

A standard Host object.

listed
required
boolean

If the Host is listed or not. This will always be false for this event.

total
required
integer
Default: 0

The total number of data sources this Host is currently listed on. This will always be 0 for this event.

details
required
Array of arrays

An array of data sources that matched this Host. This will always be empty for this event.

Responses

Request samples

Content type
application/json
{
  • "event_sid": "EV67bca97cf42743beac24264790faf6dd",
  • "event_type": "rbl.host.delisted",
  • "event_date": "2025-12-29T18:30:27+00:00",
  • "check_sid": "PPf93d71a4a9892defde3ce995b141391dbbb95dcb000279fe51f4191f8bf41e1a",
  • "host": {
    },
  • "listed": false,
  • "total": 0,
  • "details": [ ]
}

Billing Events

Events triggered related to accounts, billing, and payments.

Balance Alert Webhook

Triggered when your account balance goes below your configured alert threshold.

Request Body schema: application/json
event_sid
required
string^EV[0-9a-fA-F]{32}$

The unique SID of the event.

event_type
required
string

The event type indicator.

event_date
required
string <date-time>

The date the event was triggered in GMT.

balance
required
string

Your current account balance (in USD).

alert_threshold
required
string

Your configured low-balance alert threshold (in USD).

Responses

Request samples

Content type
application/json
{
  • "event_sid": "EV67bca97cf42743beac24264790faf6dd",
  • "event_type": "billing.balance.alert",
  • "event_date": "2025-12-29T18:30:27+00:00",
  • "balance": "12.34",
  • "alert_threshold": "15.00"
}

Recharge Success Webhook

Triggered when an auto-recharge is successful.

Request Body schema: application/json
event_sid
required
string^EV[0-9a-fA-F]{32}$

The unique SID of the event.

event_type
required
string

The event type indicator.

event_date
required
string <date-time>

The date the event was triggered in GMT.

falls_below
required
string

The currently configured auto-recharge threshold (in USD).

recharge_to
required
string

The currently configured auto-recharge amount (in USD).

required
object

Payment details related to this auto-recharge event.

Responses

Request samples

Content type
application/json
{
  • "event_sid": "EV67bca97cf42743beac24264790faf6dd",
  • "event_type": "billing.recharge.success",
  • "event_date": "2025-12-29T18:30:27+00:00",
  • "falls_below": "5.00",
  • "recharge_to": "25.00",
  • "payment": {
    }
}

Recharge Failure Webhook

Triggered when an auto-recharge attempt fails.

Request Body schema: application/json
event_sid
required
string^EV[0-9a-fA-F]{32}$

The unique SID of the event.

event_type
required
string

The event type indicator.

event_date
required
string <date-time>

The date the event was triggered in GMT.

falls_below
required
string

The currently configured auto-recharge threshold (in USD).

recharge_to
required
string

The currently configured auto-recharge amount (in USD).

Responses

Request samples

Content type
application/json
{
  • "event_sid": "EV67bca97cf42743beac24264790faf6dd",
  • "event_type": "billing.recharge.failed",
  • "event_date": "2025-12-29T18:30:27+00:00",
  • "falls_below": "5.00",
  • "recharge_to": "25.00"
}

Renewal Success Webhook

Triggered when your billing package is set to auto-renew, and the auto-renewal process completes successfully.

Request Body schema: application/json
event_sid
required
string^EV[0-9a-fA-F]{32}$

The unique SID of the event.

event_type
required
string

The event type indicator.

event_date
required
string <date-time>

The date the event was triggered in GMT.

required
object

The plan object that was just renewed.

required
object

Payment details related to this plan auto-renewal event.

Responses

Request samples

Content type
application/json
{
  • "event_sid": "EV67bca97cf42743beac24264790faf6dd",
  • "event_type": "billing.renewal.success",
  • "event_date": "2025-12-29T18:30:27+00:00",
  • "plan": {
    },
  • "payment": {
    }
}

Renewal Failure Webhook

Triggered when your billing package is set to auto-renew, but the auto-renewal process attempt fails.

Request Body schema: application/json
event_sid
required
string^EV[0-9a-fA-F]{32}$

The unique SID of the event.

event_type
required
string

The event type indicator.

event_date
required
string <date-time>

The date the event was triggered in GMT.

required
object

The plan object of the auto-renewal attempt.

Responses

Request samples

Content type
application/json
{
  • "event_sid": "EV67bca97cf42743beac24264790faf6dd",
  • "event_type": "billing.renewal.failed",
  • "event_date": "2025-12-29T18:30:27+00:00",
  • "plan": {
    }
}

Card Expiration Webhook

Triggered when one of your credit cards is about to expire.

Request Body schema: application/json
event_sid
required
string^EV[0-9a-fA-F]{32}$

The unique SID of the event.

event_type
required
string

The event type indicator.

event_date
required
string <date-time>

The date the event was triggered in GMT.

required
object

The payment source object that is expiring.

Responses

Request samples

Content type
application/json
{
  • "event_sid": "EV67bca97cf42743beac24264790faf6dd",
  • "event_type": "expiring.card.alert",
  • "event_date": "2025-12-29T18:30:27+00:00",
  • "payment_source": {
    }
}

Plan Expiration Webhook

Triggered when your billing package is set to expire and auto-renewal is disabled.

Request Body schema: application/json
event_sid
required
string^EV[0-9a-fA-F]{32}$

The unique SID of the event.

event_type
required
string

The event type indicator.

event_date
required
string <date-time>

The date the event was triggered in GMT.

required
object

The plan object that is expiring.

Responses

Request samples

Content type
application/json
{
  • "event_sid": "EV67bca97cf42743beac24264790faf6dd",
  • "event_type": "expiring.plan.alert",
  • "event_date": "2025-12-29T18:30:27+00:00",
  • "plan": {
    }
}