Alert V3

Fetch alert by id

Changed on

Fetch an alert by id.

Using the fields parameter the response can be set to include a set of fields. If no fields parameter is set, all available fields will be included in the response. For better performance it is recommended to use the fields parameter to limit the response to only return the fields you need.

get/v3/{alert_id}

Request

  • Base URL
    api.recordedfuture.com/alert (relative, and the document’s source URL is not known)
  • Auth
    API key in header X-RFToken

Path parameters

alert_idstring required
Example:5PqsAw

Id of alert to fetch

Query parameters

fieldsstring

Fields to include in the response. If no specific fields are requested, all available fields are included in the response.

Values should be separated by comma.

Available fields are:

  • ai_insights
  • enriched_entities
  • hits
  • id
  • log
  • owner_organisation_details
  • review
  • rule
  • title
  • triggered_by
  • type
  • url
taggedTextboolean

Include text tags

Response

The current state of the alert

Changes

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the ///// response's property type changed from string to object null for status

    • breaking

      the /// response's property type changed from no type to object null for status

    • warning

      added the new ENTITY enum value to the / response property for the response status

    • warning

      added the new EVENT enum value to the / response property for the response status

    • warning

      added the new OTHER enum value to the / response property for the response status

    • warning

      added the new REFERENCE enum value to the / response property for the response status

    • warning

      added the new Unknown enum value to the // response property for the response status

    • warning

      added the new undefined enum value to the // response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      response property data/review/status deprecated

    • info

      removed subschema #1 subschema #2 from the /// response property oneOf list for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property /// to the response with the status