Domain Lists API

Domain lists can be created, edited and viewed using the domain list api.  When you have created a domain list, you can attach that domain list to a demand or supply tag for targeting. 



Creating a domain list

SDK

Use tab completion with SDK to auto-complete function names or show field options!

REST API

POST /api/v0/domain_lists

Headers

Body (example)

{
    "name": "My Domain List",
        "description": "My description"
}

Required parameters: name

Response

Status code 200


Get a Domain List

SDK

REST API

GET /api/v0/domain_lists/<id>

Headers


Response

Status code 200



Add Domains

SDK

REST API

POST /api/v0/domain_lists/<id>/domains/bulk_create

Headers

Body (example)


Response

Status code 200


Append Domains to a Domain List From a File

REST API

POST /api/v0/domain_lists/<id>/domains/file_bulk_create

curl --location --request POST 'https://console.springserve.com/api/v0/domain_lists/<id>/domains/file_bulk_create' \
--header 'Content-Type: application/json' \
--header 'Authorization: <yourAuthToken>' \
--form 'csv_file=@"/<filepath>/domain_list.csv"'

Response

Status code 201

{"created": True}

Get Domains in Domain List

SDK

REST API

GET /api/v0/domain_lists/<id>/domains

Headers


Response (note you need to pagenate)

Status code 200


Remove Domains

SDK

REST API

POST /api/v0/domain_lists/<id>/domains/bulk_replace

Headers

Body (example)

Replace All Domains with a File

REST API

POST /api/v0/domain_lists/<id>/domains/file_bulk_replace

curl --location --request POST 'https://console.springserve.com/api/v0/domain_lists/<id>/domains/file_bulk_replace' \
--header 'Content-Type: application/json' \
--header 'Authorization: <yourAuthToken>' \
--form 'csv_file=@"/<filepath>/replacement_domain_list.csv"'

Response

Status code 201

{"created": True}

Remove Domains

SDK

REST API

DELETE /api/v0/domain_lists/<id>/domains/bulk_delete

Headers

Body (example)


Response (note you need to pagenate)

Status code 200


Remove Domains in a File from a Domain List

REST API

DELETE /api/v0/domain_lists/<id>/domains/file_bulk_delete

curl --location --request POST 'https://console.springserve.com/api/v0/domain_lists/<id>/domains/file_bulk_delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: <yourAuthToken>' \
--form 'csv_file=@"/<filepath>/deletion_domain_list.csv"'

Response

Status code 201

{"created": True}


Attach to a Demand or Supply Tag

To attach a domain list to a supply or demand tag you must set the following fields on a supply or demand tag

  • domain_list_ids → this is a list of domain list ids that you want to target on the supply or demand tag
  • domain_targeting → Whether or not to treat it like an 'Allowlist' or 'Blocklist'

SDK

REST API

See documentation on the Supply and Demand Tag APIs