---
title: "Update a share"
method: PUT
path: "/api/v1/shares/{id}"
tags: ["Shares"]
---

# Update a share

`PUT /api/v1/shares/{id}`

## Path parameters

- `id` string, uuid, required

## Request body

- CreateUpdateShareRequest
  - `share` Share, required
    - `allowed_domains` string[], nullable, required — Domains permitted to embed this share. Empty means no restriction.
    - `created_by` string, uuid, required — User who created the share.
    - `enabled_views` TopologyView[], nullable, required — Which topology views are enabled for this share. None = all views (subject to data availability). Some(list) = only these views in order. First element is the default view shown on load.
    - `expires_at` string, date-time, nullable, required — When this record stops being valid.
    - `is_enabled` boolean, required — Whether the link still resolves. Disabled shares return 404.
    - `name` string, required — Human-facing name for this share.
    - `network_id` string, uuid, required — The network this entity belongs to.
    - `options` ShareOptions, required — Share display options
      - `show_export_button` boolean, required — Viewer sees the export button.
      - `show_inspect_panel` boolean, required — Viewer can open the inspector for a selected element.
      - `show_minimap` boolean, required — Viewer sees the minimap.
      - `show_zoom_controls` boolean, required — Viewer sees the zoom controls.
    - `password` string, password, nullable — Plaintext password on ingest; redacted sentinel (`"********"`) or `None` on egress. Never stored — `password_hash` is the DB column. Wrapped in `SecretString` so `Debug`/logging shows `[REDACTED]` during the window between request deserialization and hashing.
    - `topology_id` string, uuid, required — The topology this share exposes.
    - `created_at` string, date-time, required — When this record was first created.
    - `id` string, uuid, required — Server-assigned unique identifier.
    - `updated_at` string, date-time, required — When this record was last modified.

## Response `200`

Share updated

- ApiResponseShare
  - `data` object — The result payload. Omitted on failure.
    - `allowed_domains` string[], nullable, required — Domains permitted to embed this share. Empty means no restriction.
    - `created_by` string, uuid, required — User who created the share.
    - `enabled_views` TopologyView[], nullable, required — Which topology views are enabled for this share. None = all views (subject to data availability). Some(list) = only these views in order. First element is the default view shown on load.
    - `expires_at` string, date-time, nullable, required — When this record stops being valid.
    - `is_enabled` boolean, required — Whether the link still resolves. Disabled shares return 404.
    - `name` string, required — Human-facing name for this share.
    - `network_id` string, uuid, required — The network this entity belongs to.
    - `options` ShareOptions, required — Share display options
      - `show_export_button` boolean, required — Viewer sees the export button.
      - `show_inspect_panel` boolean, required — Viewer can open the inspector for a selected element.
      - `show_minimap` boolean, required — Viewer sees the minimap.
      - `show_zoom_controls` boolean, required — Viewer sees the zoom controls.
    - `password` string, password, nullable — Plaintext password on ingest; redacted sentinel (`"********"`) or `None` on egress. Never stored — `password_hash` is the DB column. Wrapped in `SecretString` so `Debug`/logging shows `[REDACTED]` during the window between request deserialization and hashing.
    - `topology_id` string, uuid, required — The topology this share exposes.
    - `created_at` string, date-time, required — When this record was first created.
    - `id` string, uuid, required — Server-assigned unique identifier.
    - `updated_at` string, date-time, required — When this record was last modified.
  - `error` string, nullable — Human-readable failure message. Omitted on success.
  - `meta` ApiMeta, required — API metadata included in all responses
    - `api_version` integer, required — API version (integer, increments on breaking changes)
    - `server_version` string, required — Server version (semver)
  - `success` boolean, required — `true` when the request succeeded. `false` responses carry `error` instead of `data`.

## Other responses

- `404` — Share not found

---

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