---
title: "Get Edge"
method: GET
path: "/edges/{edge_id}"
tags: ["Edge Appliances (Edge)"]
---

# Get Edge

`GET /edges/{edge_id}`

## Request

- Base URL: `https://am1.portal.api.nasuni.com`
- URL: `https://am1.portal.api.nasuni.com/edges/{edge_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nasuni/apis/portal-api/docs/edges/:edge_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get the consolidated detail read model for a specific Edge appliance.

Args:
    edge_id: The unique identifier of the Edge appliance

Returns:
    EdgeDto: Detailed information about the Edge appliance

## Path parameters

- `edge_id` string, uuid, required

## Response `200`

Edge appliance retrieved successfully

- EdgeDto
  - `id` string, uuid, required
  - `description` string, required
  - `type` 'Edge' | 'Strider'
  - `services` EdgeServicesDto
    - `s3_edge` boolean, nullable
    - `file_iq` boolean, nullable
  - `serial` string, uuid, required
  - `instance_id` string, uuid, nullable
  - `synced` boolean
  - `is_reachable` boolean
  - `last_seen_at` string, date-time, nullable
  - `owned_volumes` integer, nullable
  - `remotely_connected_volumes` integer, nullable
  - `volumes` EdgeVolumes, required
    - `owned` integer, nullable
    - `remotely_connected` integer, nullable
  - `build` EdgeBuild, required
    - `current` string, required
    - `available` string, nullable
    - `platform` string, nullable
  - `machine` EdgeMachine, required
    - `cpu` string, nullable
    - `ram` string, nullable
    - `cache_disk` string, nullable
    - `os_disk` string, nullable
    - `fiq_disk` string, nullable
    - `cow_disk` string, nullable
    - `cpu_cores` integer, nullable
    - `vm_instance_type` string, nullable
    - `vm_region` string, nullable
  - `ipaddress` string, nullable
  - `hostname` string, nullable
  - `uptime_seconds` integer, nullable
  - `health_status` object, nullable
  - `location` string, nullable
  - `last_config_backup_date` string, nullable
  - `reported_account_max_now_storage` integer, nullable
  - `reported_account_current_now_storage` integer, nullable
  - `ds_type` string, nullable
  - `system` EdgeSystem: Read-only system values. ``None`` means the appliance did not report it.
    - `automatic_updates` EdgeAutomaticUpdates: Read-only automatic-update values reported by the appliance.
      - `enabled` boolean, nullable
      - `schedule` string, nullable
    - `remote_support` string, nullable
    - `time_configuration` string, nullable
    - `cache_eviction_settings` string, nullable
    - `ip_source` string, nullable
    - `default_gateway` string, nullable
    - `dns_servers` string, nullable
    - `search_domains` string, nullable
    - `snmp_enabled` boolean, nullable
    - `qos_rule_count` integer, nullable
    - `syslog_enabled` boolean, nullable
    - `disk_encryption` string, nullable
    - `encryption_key_count` integer, nullable
    - `escrow_passphrase_enabled` boolean, nullable
    - `ssl_certificate_name` string, nullable
    - `ssl_certificate_count` integer, nullable
    - `strider` EdgeStriderSystem: Strider-only values prepared by the appliance read model.
      - `vm_management` string, nullable
      - `scale_factor` integer, nullable
      - `fault_tolerance` string, nullable
    - `access_points` EdgeAccessPoints: Read-only appliance access-point summary values.
      - `web_access_enabled` boolean, nullable
      - `web_access_share_count` integer, nullable
      - `smb_share_count` integer, nullable
      - `smb_client_count` integer, nullable
      - `smb_lock_count` integer, nullable
      - `nfs_export_count` integer, nullable
      - `ftp_directory_count` integer, nullable
  - `tasks` TaskStateSummaryDto[], nullable
    - `id` string, uuid, required
    - `created_at` string, date-time, required
    - `resource` string, required
    - `resource_id` union
      - string, uuid
      - string
    - `action` string, required
    - `executor_id` string, uuid, nullable
    - `state` 'in_progress' | 'completed' | 'failed', required

## Other responses

- `401`: Not authenticated
- `403`: Insufficient permissions
- `404`: Resource not found
- `409`: Resource state conflict
- `422`: Invalid input data
- `500`: Internal server error

---

[API](https://skmtc.dev/nasuni/apis/portal-api.md) - [All operations](https://skmtc.dev/nasuni/apis/portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nasuni/apis/portal-api/revisions/2a505bec6d14?raw)