v1

latestOpenAPI 3.0.42026-08-064075233.0 KB

EdgeNodes

Get node by id

Returns a node with the specified id.

get/api/edgenodes/{id}

Path parameters

idstring uuid required

The identifier for the node that we want to get.

Query parameters

compactboolean

If true the response will be compacted and only contain the most important information about the node.

includeStatisticsboolean

If true the response will include statistics about the node. If set to true, compact must also be true.

Response

Representation of a node. Note that some of the properties listed below will be included depending on the query parameters set in the request.

idstring uuid

The identifier of the node.

organizationIdstring uuid

The identifier of the organization.

namestring nullable

The name of the node.

accessKeystring nullable

The access key of the node.

inSyncboolean nullable

Whether all of the deployed flows on the node are in sync with the EdgeDirector, meaning that they have the latest set of parameters.

createdAtstring date-time

The time the node was created.

createdBystring uuid

The user that created the node.

updatedAtstring date-time

The time the node was last updated.

updatedBystring uuid

The user that last updated the node.

nrOfFlowDeploymentsinteger

The number of flow deployments on the node.

nrOfParameterOverridesinteger

The number of parameter that are overridden for the node.

hostedboolean

Whether the node is hosted by Crosser.

typestring nullable

reviewedAtstring date-time

The time the node was last reviewed. Reviewing a node means that all errors and warnings occured to that point are treated as handled and only new errors and warnings after that point are included when status and statistics are calculated.

Example response

{
  "id": "88cd62fa-6cb1-43d3-b243-787bd6ec8041",
  "organizationId": "8c84e649-1669-428c-8506-47b0815180e8",
  "name": "MyNode",
  "inSync": true,
  "createdAt": "2024-09-24T09:33:38.013347Z",
  "createdBy": "256f791c-fbc0-4435-9429-d291227f6577",
  "updatedAt": "2024-09-24T09:33:38.013347Z",
  "updatedBy": "256f791c-fbc0-4435-9429-d291227f6577",
  "information": {
    "osVersion": "Unix 4.9.93.0",
    "machineName": "0cd53a173a06",
    "processorCount": 4,
    "is64BitProcess": true,
    "is64BitOperatingSystem": true,
    "crosserCoreVersion": "2.5.6",
    "frameworkDescription": ".NET 6.0.11",
    "osDescription": "Linux 5.4.72-microsoft-standard-WSL2 #1 SMP Wed Oct 28 23:40:43 UTC 2020",
    "osArchitecture": "X64"
  },
  "labels": {
    "limit": 10,
    "count": 100,
    "items": [
      {
        "id": "17c2316e-901c-4c6f-8ee5-18abf4075d60",
        "organizationId": "8c84e649-1669-428c-8506-47b0815180e8",
        "name": "My label",
        "createdAt": "2024-09-24T09:33:38.013347Z",
        "createdBy": {
          "id": "256f791c-fbc0-4435-9429-d291227f6577",
          "name": "My User"
        },
        "updatedAt": "2024-09-24T09:33:38.013347Z",
        "updatedBy": {
          "id": "256f791c-fbc0-4435-9429-d291227f6577",
          "name": "My User"
        }
      }
    ]
  },
  "flowDeployments": {
    "limit": 10,
    "count": 100,
    "items": [
      {
        "id": "2896e0bd-ef25-4315-9e61-4bebfb53612b",
        "reportedState": "Stopped",
        "wantedState": "Started",
        "edgeNodeId": "88cd62fa-6cb1-43d3-b243-787bd6ec8041",
        "flowId": "955a5c39-e3fe-4f30-ac78-e1648f18f491",
        "flowDefinitionId": "0bb6b120-468a-4c7b-b121-65e88e990c9d",
        "organizationId": "8c84e649-1669-428c-8506-47b0815180e8",
        "parameters": [
          {
            "id": "My parameter",
            "type": "String",
            "organizationId": "8c84e649-1669-428c-8506-47b0815180e8",
            "createdAt": "2024-09-24T09:33:38.013347Z",
            "createdBy": "256f791c-fbc0-4435-9429-d291227f6577",
            "updatedAt": "2024-09-24T09:33:38.013347Z",
            "updatedBy": "256f791c-fbc0-4435-9429-d291227f6577",
            "value": {
              "id": "My parameter",
              "organizationId": "8c84e649-1669-428c-8506-47b0815180e8",
              "type": "String"
            },
            "flowDeploymentId": "2896e0bd-ef25-4315-9e61-4bebfb53612b"
          }
        ],
        "parametersInSync": true
      }
    ]
  },
  "nrOfFlowDeployments": 3,
  "nrOfParameterOverrides": 3,
  "statistics": {
    "organizationId": "8c84e649-1669-428c-8506-47b0815180e8",
    "edgenodeId": "88cd62fa-6cb1-43d3-b243-787bd6ec8041",
    "summary": {
      "uptime": [
        6625.1123
      ],
      "cpu": [
        0.5
      ],
      "bytesReceived": [
        458920
      ],
      "bytesSent": [
        41231
      ],
      "workingSet": [
        85912140
      ],
      "flowsMessagesReceived": [
        561231
      ],
      "flowsMessagesSent": [
        8345
      ],
      "warnings": [
        5123
      ],
      "errors": [
        42
      ],
      "timestamp": [
        "2024-09-30T09:02:02.36Z"
      ]
    },
    "host": {
      "uptime": [
        6625.1123
      ],
      "cpu": [
        0.5
      ],
      "bytesReceived": [
        458920
      ],
      "bytesSent": [
        41231
      ],
      "httpMessagesIn": [
        561231
      ],
      "mqttMessagesIn": [
        123
      ],
      "mqttMessagesOut": [
        8345
      ],
      "workingSet": [
        85912140
      ],
      "warnings": [
        5123
      ],
      "errors": [
        42
      ],
      "timestamp": [
        "2024-09-30T09:02:02.36Z"
      ]
    },
    "flowDeployments": [
      {
        "flowDeploymentId": "2896e0bd-ef25-4315-9e61-4bebfb53612b",
        "uptime": [
          6625.1123
        ],
        "cpu": [
          0.5
        ],
        "messagesReceived": [
          561231
        ],
        "messagesSent": [
          8345
        ],
        "bytesReceived": [
          458920
        ],
        "bytesSent": [
          41231
        ],
        "workingSet": [
          85912140
        ],
        "warnings": [
          5123
        ],
        "errors": [
          42
        ],
        "timestamp": [
          "2024-09-30T09:02:02.36Z"
        ]
      }
    ]
  },
  "reviewedAt": "2024-09-24T09:33:38.013347Z",
  "reviewedBy": {
    "type": "User",
    "id": "256f791c-fbc0-4435-9429-d291227f6577",
    "name": "My User"
  }
}