Setup Guide for Customer Feed API

Enterprise Customers use the Customer Feed API to automate feed creation, management, and enrichment in the Silent Push platform. Use the following guide to configure and integrate the Customer Feed API.

Before starting, ensure you have the following for a successful setup:

Required

You must have the following to successfully complete this guide:

• Enterprise Subscription: An active Silent Push Enterprise subscription.

• User Identifier Key: A unique key required for authentication. This key is found on the subscription page of the Silent Push platform.

• Network Access: The environment must allow outbound HTTPS requests to https://api.threatcheck.silentpush.com/v1/.

Process

1. Gain the User Identifier Key

2. Setup Feeds

3. Manage Indicators

4. Manage Tags

5. Authenication

6. Base URL and Versioning

7. Test and Validation

1.Gain the User Identification Key

Note: The key is masked by default.

2.Setup Feeds

Use the following endpoints to create and manage feeds:

• Create a Feed (POST /api/v1/feeds/):

  • Request body example:
    {

     "name": "Critical Threat Feed",

     "description": "Feed for tracking high-risk indicators",

     "source": "customer_import"

    }

  • Response: Includes a unique uuid for the new feed.

• Retrieve/Update/Delete a Feed (GET/PUT/PATCH/DELETE /api/v1/feeds/{uuid}/):

  • Retrieve feed details or modify properties such as description and name.

  • Delete a feed if it is no longer needed.

• Enrich a Feed (POST /api/v1/feeds/{uuid}/enrich/):

  • Appends additional data to indicators within a feed.

3.Manage Indicators

• List Indicators (GET /api/v1/feeds/{feed_uuid}/indicators/): Retrieves all indicators in a feed.

• Retrieve an Indicator (GET /api/v1/feeds/{feed_uuid}/indicators/{name}/): Retrieves details about a specific indicator.

• Bulk Delete Indicators (POST /api/v1/feeds/{feed_uuid}/indicators/bulk-delete/): Removes multiple indicators at once.

• Update Indicator Tags (PUT /api/v1/feeds/{feed_uuid}/indicators/{name}/update-tags/): Adds or removes tags for an indicator.

4.Manage Tags

• List and Add Tags (GET/POST /api/v1/feeds/{feed_uuid}/tags/): Retrieve existing tags or add a new tag to a feed.

• Manage a Specific Tag (GET/PUT/DELETE /api/v1/feeds/{feed_uuid}/tags/{tag__name}/): Retrieve, update, or delete an individual tag.

• Bulk Delete Tags (POST /api/v1/feeds/{feed_uuid}/tags/bulk-delete/): Removes multiple tags in one operation.

5.Authentication

Include the API key in the request header:

• Authorization: Bearer <your_api_key>

Note: Requests that do not include a valid key receive an HTTP 401 Unauthorized response.

6.Base URL and Versioning

Use the following base URL for all endpoints:

• https://api.silentpush.com/api/v1/

Endpoints are versioned to ensure backward compatibility. The current version is v1.

7.Test and Validation

Complete the following process to test and verify your configuration:

1. Create a Test Feed: Submit a POST /api/v1/feeds/ request with sample data.

2. Verify Creation: Use GET /api/v1/feeds/{uuid}/ to confirm the feed was created.

3. Add Indicators: Use POST /api/v1/feeds/{feed_uuid}/indicators/ to add a sample indicator.

4. Retrieve Indicators: Confirm the indicator was added using GET /api/v1/feeds/{feed_uuid}/indicators/.