RErecordedfuture
Flow

Create a flow

Create a new flow with a certain configuration.

post/flows

Request

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

idstring

Id of the flow

namestring
descriptionstring
ownerstring

ID (uhash) of user that should own the flow

schedulestring
tag'internal'

Example request

{
  "id": "my-flow",
  "name": "my-flow",
  "description": "My flow to fetch IP data",
  "owner": "3Gi9ha",
  "blocks": [
    {
      "id": "my_custom_block",
      "description": "Custom block that fetches data from the NVD database.",
      "params": [
        {
          "name": "severity",
          "required": true,
          "default_value": "high"
        }
      ],
      "inputs": []
    }
  ],
  "schedule": "0 * * * *"
}

Response

Flow configuration

idstring

Id of the flow

namestring
ownerstring

ID (uhash) of user that owns the flow

descriptionstring
last_runstring date-time
schedulestring
versioninteger required

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

tag'internal'

Example response

{
  "id": "my-flow",
  "name": "my-flow",
  "owner": "3Gi9ha",
  "description": "My flow to fetch IP data",
  "blocks": [
    {
      "id": "my_custom_block",
      "description": "Custom block that fetches data from the NVD database.",
      "params": [
        {
          "name": "severity",
          "required": true,
          "default_value": "high"
        }
      ],
      "inputs": []
    }
  ],
  "last_run": "2024-01-01T13:00:00.000Z",
  "schedule": "0 * * * *"
}

Changes

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