RErecordedfuture
Flow

Fetch the status of a flow or flow job

Fetch the status of a flow job. You can filter on the job_id or flow_id

post/flows/status

Request

  • Base URL
    https://api.recordedfuture.com/fusion/v3
  • URL
    https://api.recordedfuture.com/fusion/v3/flows/status
  • Auth
    • API key in header X-RFToken
    • or OAuth 2
      Authorization code: https://id.recordedfuture.com/authorize
      Token URL: https://id.recordedfuture.com/token

Request body

job_idstring

A flow job id.

flow_idstring

A flow id.

limitinteger

Maximum number of job statuses to include in response.

Example request

{
  "job_id": "452d3415-3178-4d54-b483-99a774be3f71",
  "flow_id": "my-flow",
  "limit": 10
}

Response

Operation result

job_idstring required

Job id

ownerstring required

Owner ID (uhash) of the flow.

flow_idstring required

Flow id

block_statesobject[] required

The state of each block in the flow configuration.

record_countnumber required

The number of records processed by the flow (so far if not completed).

error_messagestring

Error message string, shows the cause of flow failure.

blockstring

The block id from where the flow executed. Only present when the flow was started using the run endpoint with the block parameter set.

startedstring date-string
updatedstring date-string
finishedstring date-string
failedstring date-string
abortedstring date-string
createdstring date-string
versioninteger required

Flow version, essentially counts the number of updates made to the flow configuration.

retriesinteger required

The number of times the flow has been retried after failing.

Example response

[
  {
    "job_id": "452d3415-3178-4d54-b483-99a774be3f71",
    "owner": "3Gi9ha",
    "flow_id": "my-flow"
  }
]

Changes

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