Flow Details

The flow details page shows detailed information about a single flow, including its current status, configuration, and API documentation. This page has multiple tabs and controls for managing and monitoring the flow.

You can access flow details by selecting a flow from the flow list or by searching for it in the Flows page.

The overview tab displays the flow’s message state:

The console displays a single flow’s total count of in-flight, complete, and failed messages.

The time range you set from the calendar button () applies to this overview as well.

Disable Flows

Enable the flowControl feature flag in your values.yaml configuration to show the pause button. 
  features.js: |
      window = window || {};
      window.features = {
          flowControl: true
      };

To temporarily disable a flow with a REST, SOAP, or handoff source, open the flow page and select the pause button () in the top-right corner. Provide a reason for disabling the flow. Other users can see this reason. The following image demonstrates a flow that has been paused:

The flow page displays an orange banner that says it was disabled by admin@mycompany.com for testing reasons.

Pausing the flow causes any REST API endpoints to return a 503 status with the following payload:

{
  "message": "Request rejected because the endpoint has been disabled."
}

To re-enable the flow and remove the warning, select the play button () in the top-right corner.

Flow Spec

Select the Flow Spec tab to review a flow’s specification. The following button on the right side of the page will change the view accordingly:

Button Description

Coding brackets.

A low-code view of the object-oriented flow spec with expandable and collapsible nodes.
The Flow spec tab shows details about the flows configuration and processors.

Documentation

If the flow is a REST API, its OpenAPI resource is converted into a testable UI, enabling the Documentation tab. The following image shows what this tab looks like:

The Documentation tab displays a POST endpoint for a REST API.

Use the documentation interface to view and test OpenAPI schemas directly in the browser. Expanding an HTTP request type, such as POST, shows the parameters, expected request body, and possible responses, as shown in the following image:

The expanded POST request displays an example request body in JSON format.

Select Try it out, and then select Send to send a request to the endpoint. The following image shows a POST request that returned a 401 status:

The page displays the curl command that ran the POST request and the returned 401 Unauthorized message.
The Try it out feature works only when you provide valid credentials. Select Authorize at the top of the page, and then enter a valid username and password. For more information about generating credentials, see Flow Access.

Flow Access

Flow access displays a list of the Connect service accounts that have access to this flow.

For more information on Connect service accounts and how to create and manage access to flows, see Service accounts. To troubleshoot access issues, see Flow access troubleshooting.

Additional Resources