RErecordedfuture
Flow

Run a flow

Runs a flow on demand without waiting for its schedule.

post/flows/{id}/run

Request

  • Base URL
    https://api.recordedfuture.com/fusion/v3
  • URL
    https://api.recordedfuture.com/fusion/v3/flows/{id}/run
  • 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

idstring required

Flow id

Request body

blockstring

Specifies the block from which the flow should be executed. In practice, this means that only the blocks that are directly or indirectly connected to the inputs of this block will be executed. By default this is the first FileApiSinkBlock in the list of blocks.

samplesinteger

Specifies the number of samples to include in the execution state. The samples are helpful when debugging a flow.

Example request

{
  "block": "output_file",
  "samples": 100000
}

Response

Flow job

job_idstring

Id of flow job

Example response

{
  "job_id": "452d3415-3178-4d54-b483-99a774be3f71"
}

Changes

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