Setup Guide for Customer Feed API

Updated
  • Updated on Aug 21, 2025
  • Published on Apr 24, 2025
  • 1 minute(s) read
Prev Next

Enterprise customers can leverage the Customer Feed API to automate the creation, management, and enrichment of feeds within the Silent Push platform. This guide provides clear steps to configure and integrate the API effectively.

Prerequisites

Before beginning, ensure you have the following requirements in place to complete the setup successfully:

  1. Enterprise Subscription: An active Silent Push Enterprise subscription is required.

  2. User Identifier Key: A unique authentication key, available on the subscription page of the Silent Push platform.

  3. Network Access: Your environment must support outbound HTTPS requests to https://api.threatcheck.silentpush.com/v1/.

Obtain the User Identification Key

Note: The API key is masked by default for security.

View the API Key

  1. Sign in to the Silent Push platform.

  2. Click your profile icon.

  3. Select Organization.

  4. Choose API Keys.

  5. Copy the API Key for use in your requests.

Set Up 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: Returns a unique UUID for the new feed.

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

  • Retrieve feed details or modify properties like name and description.

  • Delete a feed when it is no longer needed.

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

  • Adds additional data to indicators within the specified feed.

Manage Indicators

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

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

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

  • Update Indicator Tags (PUT /api/v1/feeds/{feed_uuid}/indicators/{name}/update-tags/): Add or remove tags for a specific indicator.

Manage Tags

  • List and Add Tags (GET/POST /api/v1/feeds/{feed_uuid}/tags/): View 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/): Remove multiple tags in a single operation.

Authentication

  • Include the API key in the request header as follows:

    • Authorization: Bearer <your_api_key>

  • Note: Requests without a valid key will receive an HTTP 401 Unauthorized response.

Base URL and Versioning

  • Use the following base URL for all API endpoints:

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

  • Endpoints are versioned to maintain backward compatibility, with the current version being v1.

Test and Validation

Follow these steps to test and verify your API configuration:

  1. Submit a POST /api/v1/feeds/ request with sample data.

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

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

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

This guide ensures a smooth setup process, enabling Enterprise customers to utilize the Customer Feed API fully.