---
title: "Get Edge (getEdgeById)"
method: GET
path: "/api/edge/{edgeId}"
tags: ["edge-controller"]
---

# Get Edge (getEdgeById)

`GET /api/edge/{edgeId}`

Get the Edge object based on the provided Edge Id. If the user has the authority of 'Tenant Administrator', the server checks that the edge is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the edge is assigned to the same customer.

Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

## Path parameters

- `edgeId` string, required

## Response `200`

OK

- Edge — A JSON value representing the edge.
  - `id` EdgeId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'EDGE', required — string
  - `createdTime` integer — Timestamp of the edge creation, in milliseconds
  - `tenantId` TenantId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'TENANT', required — string
  - `customerId` CustomerId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'CUSTOMER', required — string
  - `rootRuleChainId` RuleChainId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'RULE_CHAIN', required — string
  - `name` string, required — Unique Edge Name in scope of Tenant
  - `type` string, required — Edge type
  - `label` string — Label that may be used in widgets
  - `routingKey` string, required — Edge routing key ('username') to authorize on cloud
  - `secret` string, required — Edge secret ('password') to authorize on cloud
  - `version` integer
  - `additionalInfo` unknown

---

[API](https://skmtc.net/thingsboard/apis/thingsboard-rest-api.md) · [All operations](https://skmtc.net/thingsboard/apis/thingsboard-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/thingsboard/thingsboard-rest-api/revisions/40169ccdec5c/schema)