Endpoints of Customer Feed API

Enterprise customers can perform the following actions to manage their feeds:

Create a Feed

• Endpoint: POST /api/v1/feeds/

• Description: Creates a new feed with required fields including 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 UUID, e.g., 123e4567-e89b-12d3-a456-426614174000.

Retrieve, Update, and Delete a Feed

• Endpoints:

  • GET /api/v1/feeds/{uuid}/

  • PUT /api/v1/feeds/{uuid}/

  • PATCH /api/v1/feeds/{uuid}/

  • DELETE /api/v1/feeds/{uuid}/

• GET Method Description: Retrieves details for the feed identified by 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 confirming the update.

• DELETE Method Description: Removes the feed when it is no longer needed.

Enrich a Feed

• Endpoint: POST ‘/api/v1/feeds/{uuid}/enrich/’

• Description: Enhances feed data by adding supplementary information or risk scores to indicators within the feed.

• Request Example:

{
  "enrichment_source": "external_api",
  "parameters": {
    "threshold": 5
  }
}

• Response: Returns a success message with the enriched feed object.

List Indicators

• Endpoint: GET /api/v1/feeds/{feed_uuid}/indicators/

• Description: Retrieves a list of all indicators within 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: Fetches detailed information for a specific indicator 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: POST /api/v1/feeds/{feed_uuid}/indicators/bulk-delete/

• Description: Removes multiple indicators from a feed by providing an array of indicator names or identifiers.

• Request Example:

{
  "indicators": ["malware_indicator_1", "phishing_indicator_2"]
}

• Response: Returns a success message confirming the deletion.

Update Indicator Tags

• Endpoint: PUT /api/v1/feeds/{feed_uuid}/indicators/{name}/update-tags/

• Description: Modifies the tags associated with a specific indicator.

• Request Example:

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

• Response: Returns a success response with the updated tag details.

Manage Indicator Tags

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

• GET Method Description: Retrieves a list of tags for the specified indicator.

• POST Method Description: Adds a new tag to the indicator.

• Request Example:

{
  "tag": "new_tag"
}

• DELETE Method Description: Removes a tag from the indicator.

• Request Example:

{
  "tag": "obsolete_tag"
}

• Response: Returns a success response with the updated list of tags.

List and Add Tags

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

• GET Method Description: Retrieves all tags associated with the specified feed.

• Response Example:

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

• POST Method Description: Adds a new tag to the feed.

• Request Example:

{
  "tag": "new_tag"
}

• Response: Returns a success response with the updated tag list.

Manage a Specific Tag

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

• GET Method Description: Retrieves details for a specific tag.

• PUT Method Description: Updates the tag with new attributes.

• Request Example:

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

• DELETE Method Description: Removes the specific tag from the feed.

• Response: Returns a success response with updated tag details.

Bulk Delete Tags

• Endpoint: POST /api/v1/feeds/{feed_uuid}/tags/bulk-delete/

• Description: Deletes multiple tags from the feed using an array of tag names.

• Request Example:

{
  "tags": ["obsolete_tag1", "obsolete_tag2"]
}

• Response: Returns a success response confirming the deletion.

Explore the following cURL examples to understand the practical application of Customer Feed API endpoints:

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"]
      }'