--- title: "Get node by id" method: GET path: "/api/edgenodes/{id}" tags: ["EdgeNodes"] --- # Get node by id `GET /api/edgenodes/{id}` Returns a node with the specified id. ## Path parameters - `id` string, uuid, required ## Query parameters - `compact` boolean - `includeStatistics` boolean ## Response `200` Representation of a node. Note that some of the properties listed below will be included depending on the query parameters set in the request. - EdgeNode — Object representing a node. - `id` string, uuid — The identifier of the node. - `organizationId` string, uuid — The identifier of the organization. - `name` string, nullable — The name of the node. - `accessKey` string, nullable — The access key of the node. - `inSync` boolean, 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. - `createdAt` string, date-time — The time the node was created. - `createdBy` string, uuid — The user that created the node. - `updatedAt` string, date-time — The time the node was last updated. - `updatedBy` string, uuid — The user that last updated the node. - `information` EdgeNodeInformationDto — Represents information about a node. - `edgenodeId` string, uuid - `osVersion` string, nullable — The version of the operating system on the node. - `machineName` string, nullable — The name of the machine. - `processorCount` integer — The number of processors on the node. - `is64BitProcess` boolean — Whether the process is 64 bit. - `is64BitOperatingSystem` boolean — Whether the operating system is 64 bit. - `crosserCoreVersion` string, nullable — The version of the Crosser Core on the node. - `crosserSDKVersion` SemVer - `major` integer - `minor` integer - `patch` integer - `preReleaseVersion` string, nullable - `buildMetadata` string, nullable - `frameworkDescription` string, nullable — The description of the framework. - `osDescription` string, nullable — The description of the operating system. - `osArchitecture` string, nullable — The architecture of the operating system. - `configuration` object, nullable - `labels` CollectionDto1LabelDto — Represents a 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` LabelDto[], nullable — The items in the collection. - `id` string, uuid — The identifier of the label. - `organizationId` string, uuid — The identifier of the organization. - `name` string, nullable — The name of the label. - `createdAt` string, date-time — The time the label was created. - `createdBy` CreatorDto — Represents a creator. - `type` 0 | 1 | 2 | 3 | 4 - `id` string, uuid — The identifier of the creator. - `name` string, nullable — The name of the creator. - `updatedAt` string, date-time — The time the label was last updated. - `updatedBy` CreatorDto — Represents a creator. - `type` 0 | 1 | 2 | 3 | 4 - `id` string, uuid — The identifier of the creator. - `name` string, nullable — The name of the creator. - `flowDeployments` CollectionDto1FlowDeploymentDto — Represents a 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` FlowDeploymentDto[], nullable — The items in the collection. - `id` string, uuid — The identifier of the 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`. - `edgeNodeId` string, uuid — The identifier of the node the flow is deployed on. - `flowId` string, uuid — The identifier of the flow. - `flowDefinitionId` string, uuid — The identifier of the flow definition. - `organizationId` string, uuid — The identifier of the organization. - `parameters` FlowDeploymentParameterDto[], nullable — The parameters of the 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` ParameterValueDto — Represents a value of a parameter. - `id` string, nullable — The identifier of the parameter value. Will be the same as the parameter Id. - `organizationId` string, uuid — The identifier of the organization. - `type` string, nullable — The type of the parameter. Available values are `String`, `Number`, `Boolean`, `Credential`, `Resource`, `Integer` and `Object`. - `value` unknown - `parameters` NavigationDto[], nullable - `id` string, nullable - `edgeNodeId` string, nullable - `parameterOverrides` NavigationDto[], nullable - `id` string, nullable - `edgeNodeId` string, nullable - `flowDeploymentId` string, uuid — The identifier of the deployment. - `parametersInSync` boolean — Whether the current set of parameters of the deployment set by the user in the EdgeDirector are applied to the flow on the node. - `lastReceivedMessage` string, nullable - `nrOfFlowDeployments` integer — The number of flow deployments on the node. - `nrOfParameterOverrides` integer — The number of parameter that are overridden for the node. - `hosted` boolean — Whether the node is hosted by Crosser. - `type` string, nullable - `statistics` EdgeNodeStatisticsDto — Represents statistics for a node. - `organizationId` string, uuid — The identifier of the organization. - `edgenodeId` string, uuid — The identifier of the node. - `summary` EdgeNodeSummaryStatisticsDto — Represents summary statistics for 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 will have the same length meaning that the same index across all arrays represent the same time. **Note**: Only nodes that has support for statistics will have statistics, all others will just have 0 values. - `uptime` number[], nullable — The uptime of the node. - `cpu` number[], nullable — The CPU usage of the node. - `bytesReceived` number[], nullable — The number of bytes received by the node. - `bytesSent` number[], nullable — The number of bytes sent by the node. - `workingSet` number[], nullable — The working set of the node. - `flowsMessagesReceived` number[], nullable — The number of messages received by the flows on the node. - `flowsMessagesSent` number[], nullable — The number of messages sent by the flows on the node. - `warnings` number[], nullable — The number of warnings on the node since the node was marked as `ReviewedAt`. - `errors` number[], nullable — The number of errors on the node since the node was marked as `ReviewedAt`. - `timestamp` string[], nullable — The time of the statistics. - `host` EdgeNodeHostStatisticsDto — Represents statistics for the host of 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 will have the same length meaning that the same index across all arrays represent the same time. **Note**: Only nodes that has support for statistics will have statistics, all others will just have 0 values. - `uptime` number[], nullable — The uptime of the host. - `cpu` number[], nullable — The CPU usage of the host. - `bytesReceived` number[], nullable — The number of bytes received by the host. - `bytesSent` number[], nullable — The number of bytes sent by the host. - `httpMessagesIn` number[], nullable — The number of HTTP messages received by the host. - `mqttMessagesIn` number[], nullable — The number of MQTT messages received by the host. - `mqttMessagesOut` number[], nullable — The number of MQTT messages sent by the host. - `workingSet` number[], nullable — The working set of the host. - `warnings` number[], nullable — The number of warnings on the host since the host was marked as `ReviewedAt`. - `errors` number[], nullable — The number of errors on the host since the host was marked as `ReviewedAt`. - `timestamp` string[], nullable — The time of the statistics. - `flowDeployments` FlowDeploymentStatisticsDto[], nullable — A list of the statistics for the flow deployments on the node. - `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 flow deployment was marked as `ReviewedAt`. - `errors` number[], nullable — The number of errors on the flow deployment since the flow deployment was marked as `ReviewedAt`. - `timestamp` string[], nullable — The time of the statistics. - `reviewedAt` string, 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. - `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. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `503` — Service Unavailable --- [API](https://skmtc.net/crosser/apis/edge-director-api.md) · [All operations](https://skmtc.net/crosser/apis/edge-director-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crosser/edge-director-api/versions/746b3f44e69d/schema)