App Name Lists API

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

Creating an App Name List

SDK

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

REST API

POST /api/v0/app_name_lists

Headers

Body (example)

{
    "name": "My App Name List",
    "description": "My description"
}

Required parameters: name

Response

Status code 200


Get an App Name List

SDK

REST API

GET /api/v0/app_name_lists/<id>

Headers

Response

Status code 200

Add App Names

SDK

REST API

POST /api/v0/app_name_lists/<id>/app_names/bulk_create

Headers

Body (example)

Response

Status code 200

Add App Names from a File

Appends app names in the csv file to the list

REST API

POST /api/v0/app_name_lists/<id>/app_names/file_bulk_create

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

Response

Status code 201

{"created": True}

Replace Entire App Name List

REST API

POST /api/v0/app_name_lists/<id>/app_names/bulk_replace

Headers

Content-Type application/json
Authorization "yourAuthToken"

Body (example)

{
    "app_names": ["app_name1", "app_name2"]
}

Response

Status code 201

{"created": True}

Replace Entire App Name List with a File

Replaces app name list with the app names in the csv file

REST API

POST /api/v0/app_name_lists/<id>/app_names/file_bulk_replace

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

Response

Status code 201

{"created": True}

Get App Names in App Name List

SDK

REST API

GET /api/v0/app_name_lists/<id>/app_names

Headers


Response (note you need to pagenate)

Status code 200

Remove App Names

SDK

REST API

DELETE /api/v0/app_name_lists/<id>/app_names/bulk_delete

Headers

Body (example)


Response (note you need to pagenate)

Status code 200

Remove App Names Using a File 

Removes app names in the csv file from the list

REST API

DELETE /api/v0/app_name_lists/<id>/app_names/file_bulk_delete

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

Response

Status code 200

{"deleted": True}

Attach to a Demand or Supply Tag

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

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

SDK

REST API

See documentation on the Supply and Demand Tag APIs