---
title: "Get all flow deployments by flow definition id"
method: GET
path: "/api/edgenodes/flowdeployments"
tags: ["FlowDeployment"]
---

# Get all flow deployments by flow definition id

`GET /api/edgenodes/flowdeployments`

Returns a list of all flow deployments that have the specified flow definition id.

## Query parameters

- `flowDefinitionId` string, uuid, required
- `offset` integer
- `limit` integer
- `conditions` Condition[]
  - `propertyName` string, nullable
  - `propertyValue` string, nullable
  - `operator` string, nullable
- `includeCount` boolean
- `compact` boolean

## Response `200`

A collection of flow deployments for the specified node are returned. **Note**: Depending on the `compact` flag the items in the response will contain flow deployments with varying levels of detail.

- CollectionViewModel2FlowDeploymentViewModelExtendedFlowDeploymentDtoExtended — Collection of items.
  - `offset` integer — The offset of the collection.
  - `limit` integer — The limit of the collection.
  - `count` integer, nullable — The total number of items in the collection.
  - `items` FlowDeploymentViewModelExtended[], nullable — Array of items.
    - `id` string, uuid — Unique identifier for the flow deployment.
    - `flowId` string, uuid — Unique identifier for the flow.
    - `flowDefinitionId` string, uuid — Unique identifier for the flow definition.
    - `organizationId` string, uuid — Unique identifier for the organization.
    - `edgeNodeId` string, uuid — Unique identifier for the edge node.
    - `parametersInSync` boolean — If the parameters are in sync between what is used on the node and what the user has specified on the flow in EdgeDirector.
    - `lastReceivedMessage` string, nullable — The last received message from the node for the flow deployment.
    - `reportedState` string, nullable — The state of the deployment as reported by the node. Available values are `Stopped`, `Stopping`, `Starting`, `Started`, `Failed` and `Pending`. All flows are initially in `Pending` state until the node has started deploying the flow.
    - `wantedState` string, nullable — The state of the deployment as wanted by the user specified in EdgeDirector. Available values are `Stopped`, `Started` and `Deleted`.
    - `flowDefinitionName` string, nullable — Name of the flow definition.
    - `edgeNodeName` string, nullable — Name of the edge node.
    - `edgeNodeType` string, nullable — Type of the edge node. Can be `Production` or `DevAndTest`.
    - `flowDescription` string, nullable — Description of the flow.
    - `flowVersion` integer — Version of the flow.
    - `status` string, nullable — Status of the flow deployment. Can be `Ok`, `Information´, `Warning` or `Error`.
    - `reviewedAt` string, date-time — Date and time when the flow deployment was reviewed.
    - `reviewedBy` Creator — Object representing the creator of an object.
      - `type` string, nullable — Type of the creator. Can be `Unknown`, `User`, `EdgeNode`, `EdgeNodeRegistrar` or `Anonymous`.
      - `id` string, uuid — The identifier of the creator.
      - `name` string, nullable — The name of the creator.
    - `statistics` FlowDeploymentStatistics — Represents statistics for a flow deployment on a node. All statistics are represented by a list of statistics. The lists are ordered in time according to the `Timestamp` property and all arrays must have the same length meaning that the same index across all arrays represent the same time.
      - `flowDeploymentId` string, uuid — The identifier of the flow deployment.
      - `uptime` number[], nullable — The uptime of the flow deployment.
      - `cpu` number[], nullable — The CPU usage of the flow deployment.
      - `messagesReceived` number[], nullable — The number of messages received by the flow deployment.
      - `messagesSent` number[], nullable — The number of messages sent by the flow deployment.
      - `bytesReceived` number[], nullable — The number of bytes received by the flow deployment.
      - `bytesSent` number[], nullable — The number of bytes sent by the flow deployment.
      - `workingSet` number[], nullable — The working set of the flow deployment.
      - `warnings` number[], nullable — The number of warnings on the flow deployment since the last report.
      - `errors` number[], nullable — The number of errors on the flow deployment since the last report.
      - `timestamp` string[], nullable — The time of the statistics.
    - `parameters` FlowDeploymentParameter[], nullable — Array of parameters for the flow deployment.
      - `id` string, nullable — The identifier of the parameter.
      - `type` string, nullable — The type of the parameter. Available values are `String`, `Number`, `Boolean`, `Credential`, `Resource`, `Integer` and `Object`.
      - `organizationId` string, uuid — The identifier of the organization.
      - `createdAt` string, date-time — The time the parameter was created.
      - `createdBy` string, uuid — The user that created the parameter.
      - `updatedAt` string, date-time — The time the parameter was last updated.
      - `updatedBy` string, uuid — The user that last updated the parameter.
      - `value` ParameterValue
        - `id` string, nullable
        - `organizationId` string, uuid
        - `type` string, nullable
        - `value` unknown
      - `flowDeploymentId` string, uuid — The identifier of the deployment.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `503` — Service Unavailable

---

[API](https://skmtc.dev/crosser/apis/edge-director-api.md) · [All operations](https://skmtc.dev/crosser/apis/edge-director-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/crosser/edge-director-api/revisions/746b3f44e69d/schema)