Endpoints of Customer Feed API

The endpoints in the Customer Feed API are used to help Enterprise customers with the following:

Feed Management

To manage their feeds, Enterprise customers can complete the following actions:

Create a feed

Endpoint: POST /api/v1/feeds/
Description: Creates a new feed. Required fields include feed name, description, and source.
Request Body Example:
{
"name": "Critical Threat Feed",
"description": "Feed for tracking high-risk indicators",
"source": "customer_import"
}
Response: Returns the created feed object with a unique identifier, for example uuid.

Retrieve, Update, and Delete a Feed

Endpoint:
GET /api/v1/feeds/{uuid}/
PUT/PATCH /api/v1/feeds/{uuid}/
DELETE /api/v1/feeds/{uuid}/

GET Method

Description: Retrieves details for the feed with the specified uuid.
Response Example:
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "Critical Threat Feed",
"description": "Feed for tracking high-risk indicators",
"source": "customer_import",
"created_at": "2025-03-05T14:07:13Z"
}

PUT/PATCH Method

Description: Updates one or more properties of the specified feed.
Request Example:
{
"description": "Updated description for the critical threat feed"
}
Response: Returns a success message with a status code that confirms the deletion.

Enrich a Feed

Endpoint:POST /api/v1/feeds/{uuid}/enrich/
Description: Enriches the feed data by adding additional information to indicators within the feed; supplement existing feed data with extra context or risk scores.
Request Example:
{
"enrichment_source": "external_api",
"parameters": {
"threshold": 5
}
}
Response: Returns a success message with the enriched feed object.

Indicator Management

List Indicators

Endpoint:GET /api/v1/feeds/{feed_uuid}/indicators/
Description: Retrieve a list of all the indicators that are in the specified feed.
Response Example:
{
"feed_uuid": "123e4567-e89b-12d3-a456-426614174000",
"indicators": [
{"name": "malware_indicator_1", "status": "active"},
{"name": "phishing_indicator_2", "status": "inactive"}
]
}

Retrieve a Specific Indicator

Endpoint:GET /api/v1/feeds/{feed_uuid}/indicators/{name}/
Description: Retrieve detailed information about a specific indicator that is identified by its name.
Response Example:
{
"name": "malware_indicator_1",
"description": "Indicator for a known malware threat",
"tags": ["malware", "high-risk"],
"created_at": "2025-03-05T14:07:13Z"
}

Bulk Delete Indicators

Endpoint: DELETE /api/v1/feeds/{feed_uuid}/indicators/bulk-delete/
Description: Delete multiple indicators from a specific feed. The request body must include an array of indicator names or identifiers.
Request Example:
{
"indicators": ["malware_indicator_1", "phishing_indicator_2"]
}
Response: Returns a success message that indicates the successful deletion.

Update Indicator Tags

Endpoint: PUT /api/v1/feeds/{feed_uuid}/indicators/{name}/update-tags/
Description: Update the tags of a specific indicator. The request body must include a list of tags to be applied.
Request Example:
{
"tags": ["ransomware", "urgent"]
}
Response: Returns a success response that details the new tags.

Manage Indicator Tags

Endpoint: GET/POST/DELETE /api/v1/feeds/{feed_uuid}/indicators/{name}/tags/

GET Method Description: Retrieve a list of tags for the specific indicator.

POST Method Description: Add a new tag to the specified indicator.

Request Example:
{
"tag": "new_tag"
}

DELETE Method Description: Remove a tag from the specific indicator.

Request Example:
{
"tag": "obsolete_tag"
}
Response: Returns a success response that details the updated list of tags for the specific indicator.

Tag Management

List and Add Tags

Endpoint:GET/POST /api/v1/feeds/{feed_uuid}/tags/

GET Method Description: Retrieve all the tags that are associated with the specified feed.

Response Example:
{
"feed_uuid": "123e4567-e89b-12d3-a456-426614174000",
"tags": ["malware", "phishing", "ransomware"]
}

POST Method Description: Add a new tag to the specific feed.

Request Example:
{
"tag": "new_tag"
}
Response: Returns a success response that details the updated list of tags.

Manage a Specific Tag

Endpoint:GET/PUT/DELETE /api/v1/feeds/{feed_uuid}/tags/{tag__name}/

GET Method Description: Retrieve details for a specific tag.

PUT Method Description: Update the specific tag. The request body must include new attributes for the tag.

Request Example:
{
"description": "Updated description for the tag"
}

DELETE Method Description: Delete the specific tag from the feed.

Response: Returns a success response that lists the updated tag details.

Bulk Delete Tags

Endpoint:DELETE /api/v1/feeds/{feed_uuid}/tags/bulk-delete/
Description: Delete multiple tags from the specified feed. The request body must include an array of tag names.
Request Example:
{
"tags": ["obsolete_tag1", "obsolete_tag2"]
}
Response: Return a success response that confirms the deletion.

Examples

Refer to one of the following examples to view some of the capabilities of the endpoints of our Customer Feed API:

cURL Example: Create a Feed

curl -X POST https://api.silentpush.com/api/v1/feeds/ \

-H "Authorization: Bearer YOUR_API_KEY" \

-H "Content-Type: application/json" \

-d '{

"name": "Critical Threat Feed",

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

"source": "customer_import"

}'

cURL Example: Retrieve a Feed

curl -X GET https://api.silentpush.com/api/v1/feeds/{uuid}/ \

-H "Authorization: Bearer YOUR_API_KEY"

cURL Example: Update Indicator Tags

curl -X PUT https://api.silentpush.com/api/v1/feeds/{feed_uuid}/indicators/{name}/update-tags/ \

-H "Authorization: Bearer YOUR_API_KEY" \

-H "Content-Type: application/json" \

-d '{

"tags": ["ransomware", "urgent"]

}'