RErecordedfuture
List

POST /list/{listId}/entity/add

Adds a single entity to the specified list, optionally with context metadata.

Request

  • Base URL
    https://api.recordedfuture.com
  • URL
    https://api.recordedfuture.com/list/{listId}/entity/add
  • Auth
    • API key in header X-RFToken
    • or OAuth 2
      Authorization code: https://id.recordedfuture.com/authorize
      Token URL: https://id.recordedfuture.com/token

Path parameters

listIdstring required
Example:report:P6LnLw

Unique identifier for a list (format: report:XXXXX) or a named watch list identifier, obtained from POST /list/search or POST /list/create.

Request body

contextobject

Optional arbitrary key-value metadata to attach to the entity in this list. These values are stored and returned when retrieving entities via the Get Entities endpoint.

Example request

{
  "entity": {
    "id": "ip:8.8.8.8"
  }
}

Response

Success

result'added' | 'updated' | 'unchanged' required

added if the entity was newly added, updated if it already existed and its context was changed, or unchanged if it already existed with the same context.

Changes

No recorded changes to this operation across all 1 revision of this API.