Adding an API to the whitelist

Only if you have applied Marketing Platform FixPack 10.0.0.1, perform this procedure before you create any external tasks that schedule an API call.

Procedure

  1. Open and edit the whitelist file for APIs in a text editor.

    The whitelist file for APIs Platform_Admin_Scheduler_API.properties. This file is located in the in the conf directory under your Marketing Platform installation.

  2. Enter the URI of the API you plan to schedule, and if query parameters are used, include these parameter names, without including values.

    For example suppose you want to schedule the following API call, using all of the query parameters shown.

    http://www.example.com/tickets?fields=id&state=open&sort=updated_at

    You would make the following entry in the whitelist file, listing all of the parameters.

    http://www.example.com/tickets?fields&state&sort

    With this whitelist entry, you can schedule API calls that use some or all of the listed parameters. For example:

    • http://www.example.com/tickets
    • http://www.example.com/tickets?fields=id
    • http://www.example.com/tickets?fields=id&state=open
    • http://www.example.com/tickets?fields=id&state=open&sort=updated_at
    • http://www.example.com/tickets?fields=id&sort=updated_at
    • http://www.example.com/tickets?fields=id&state=open

    API calls that use non-listed query parameters cannot be scheduled. Scheduler validation fails if any parameters are used that are not present in the whitelist.

  3. Save and close the whitelist file.

    Now you can schedule the API call on the Schedules tab of the Settings > Schedule management page.