> For the complete documentation index, see [llms.txt](https://docs.silk.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.silk.us/api-reference/endpoints/models.md).

# Models

## The Ref object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The Error object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}}}}
```

## The UserTag object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"UserTag":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"is_inheritable":{"type":"boolean"},"is_automatic":{"type":"boolean"}}}}}}
```

## The Collection object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"Collection":{"type":"object","properties":{"hits":{"type":"array","items":{},"description":"The matching objects."},"limit":{"type":"integer","description":"Page size."},"offset":{"type":"integer","description":"Offset of the first returned object."},"total":{"type":"integer","description":"Total number of matching objects."}}}}}}
```

## The CollectCollectionTask object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"CollectCollectionTask":{"type":"object","properties":{"clean_all":{"type":"boolean"},"creation_timestamp":{"type":"string"},"execution_timestamp":{"type":"string"},"fail_reason":{"nullable":true},"id":{"type":"integer"},"is_failed":{"type":"boolean"},"name":{"type":"string"},"priority":{"type":"integer"},"stage":{"type":"string"},"stage_repeated_times":{"type":"integer"},"status":{"type":"string"},"task_definition":{"type":"object","properties":{"id":{"type":"integer"},"table_name":{"type":"string"}}},"task_definition_id":{"type":"integer"},"tid":{"nullable":true},"type":{"type":"string"}}}}}}
```

## The CollectManagerCollectionTaskDefinition object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"CollectManagerCollectionTaskDefinition":{"type":"object","properties":{"auto_start":{"type":"boolean"},"collect_data_blocks":{"type":"string"},"collect_logs_interval":{"nullable":true},"collect_logs_timeout":{"type":"integer"},"default_collect_logs_interval":{"nullable":true},"default_collect_logs_timeout":{"type":"integer"},"default_description":{"type":"string"},"default_is_enabled":{"type":"boolean"},"default_period":{"type":"integer"},"default_priority":{"type":"integer"},"description":{"type":"string"},"event_type":{"type":"string"},"fetch_next_dnode":{"type":"boolean"},"id":{"type":"integer"},"is_deleted":{"type":"boolean"},"is_enabled":{"type":"boolean"},"name":{"type":"string"},"no_cleanup":{"type":"boolean"},"period":{"type":"integer"},"prepare_data_blocks":{"type":"string"},"priority":{"type":"integer"},"process_data_blocks":{"type":"string"},"send_data_blocks":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The Events object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"Events":{"type":"object","properties":{"event_id":{"type":"integer","description":"Event type identifier."},"id":{"type":"integer","description":"Unique record identifier."},"labels":{"type":"string","description":"Comma-separated category labels (e.g. `VG, CONFIGURE`)."},"level":{"type":"string","description":"Severity level, e.g. `INFO`, `WARNING`."},"message":{"type":"string","description":"Human-readable event message."},"name":{"type":"string","description":"Event name (e.g. `VG_CREATED`)."},"timestamp":{"type":"number"},"user":{"type":"string","description":"User that triggered the event."}}}}}}
```

## The EventsTargetFilters object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"EventsTargetFilters":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"label":{"type":"string","description":"Event category label (e.g. `USERS`, `SYSTEM`, `CONFIGURE`)."},"level":{"type":"string","description":"Minimum severity level to deliver, e.g. `WARNING`."},"target_id":{"type":"integer","description":"ID of the event target this filter applies to (see [targets.md](./targets.md))."}}}}}}
```

## The EventsTargets object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"EventsTargets":{"type":"object","properties":{"data":{"type":"string","description":"Target-specific data (e.g. an email address for an `e-mail` target)."},"id":{"type":"integer","description":"Unique identifier."},"name":{"type":"string","description":"Target name."},"type":{"type":"string","description":"Delivery type, e.g. `e-mail`."}}}}}}
```

## The Hosts object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"Hosts":{"type":"object","properties":{"connectivity_type":{"type":"string"},"host_group":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the parent host group, if the host is a member of one. Shape: `{ \"ref\": \"/host_groups/{id}\" }`."},"id":{"type":"integer","description":"Unique identifier."},"is_part_of_group":{"type":"boolean","description":"`true` when `host_group` is set."},"name":{"type":"string","description":"Display name."},"type":{"type":"string","description":"One of `Linux`, `Windows`, `ESX`."},"views_count":{"type":"integer","description":"Number of volume group views currently mapped to this host."},"volumes_count":{"type":"integer","description":"Number of volumes currently mapped to this host."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The HostAuthProfileMappers object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"HostAuthProfileMappers":{"type":"object","properties":{"host":{"$ref":"#/components/schemas/Ref"},"host_auth_profile":{"$ref":"#/components/schemas/Ref"},"id":{"type":"integer"}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The HostAuthProfiles object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"HostAuthProfiles":{"type":"object","properties":{"host_groups_count":{"type":"integer","description":"Number of host groups referencing this profile."},"hosts_count":{"type":"integer","description":"Number of hosts referencing this profile."},"id":{"type":"integer","description":"Unique identifier."},"name":{"type":"string","description":"Display name."},"type":{"type":"string","description":"Authentication type, e.g. `CHAP`."},"username":{"type":"string","description":"Authentication user name."}}}}}}
```

## The HostGroups object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"HostGroups":{"type":"object","properties":{"allow_different_host_types":{"type":"boolean","description":"When `true`, the group may contain hosts of mixed types (Linux, Windows, ESX). When `false`, all members must share the same `type`."},"connectivity_type":{"type":"string","description":"Reserved; defaults match the SDP's default connectivity type."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"hosts_count":{"type":"integer","description":"Number of hosts currently in the group."},"id":{"type":"integer","description":"Unique identifier."},"name":{"type":"string","description":"Display name."},"views_count":{"type":"integer","description":"Number of volume group views mapped to the group."},"volumes_count":{"type":"integer","description":"Number of volumes mapped to the group."}}}}}}
```

## The HostIqns object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"HostIqns":{"type":"object","properties":{"host":{"$ref":"#/components/schemas/Ref","description":"Reference to the host this IQN is attached to. Shape: `{ \"ref\": \"/hosts/{id}\" }`."},"host_id":{"type":"integer"},"iqn":{"type":"string","description":"The IQN value, e.g. `iqn.1991-05.com.microsoft:host01`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The Mappings object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"Mappings":{"type":"object","properties":{"host":{"$ref":"#/components/schemas/Ref","description":"Reference to the host or host group on the initiator side. Shape: `{ \"ref\": \"/hosts/{id}\" }` or `{ \"ref\": \"/host_groups/{id}\" }`. Inspect the path segment to tell which."},"id":{"type":"integer","description":"Unique identifier."},"lun":{"type":"integer","description":"LUN number presented to the initiator."},"unique_target":{"type":"boolean","description":"`true` when the mapping should expose a unique target (used in some iSCSI deployments to isolate the LUN from the host's other targets)."},"volume":{"$ref":"#/components/schemas/Ref","description":"Reference to what is being exposed. Most commonly `{ \"ref\": \"/volumes/{id}\" }`, but a snapshot or view can be exposed as `{ \"ref\": \"/snapshots/{id}\" }`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The ReplicationPeerK2arrays object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"ReplicationPeerK2arrays":{"type":"object","properties":{"bandwidth_limit":{"type":"integer","description":"Replication bandwidth cap."},"capacity_allocated":{"type":"integer","description":"Allocated capacity on the peer."},"capacity_allocated_snapshots_and_views":{"type":"integer","description":"Allocated capacity attributed to snapshots and views."},"capacity_allocated_volumes":{"type":"integer","description":"Allocated capacity attributed to volumes."},"capacity_free":{"type":"integer","description":"Free capacity on the peer."},"capacity_physical":{"type":"integer","description":"Physical capacity in use."},"capacity_provisioned":{"type":"integer","description":"Total provisioned capacity."},"capacity_provisioned_snapshots":{"type":"integer","description":"Provisioned capacity for snapshots."},"capacity_provisioned_views":{"type":"integer","description":"Provisioned capacity for views."},"capacity_provisioned_volumes":{"type":"integer","description":"Provisioned capacity for volumes."},"capacity_reserved":{"type":"integer","description":"Reserved capacity."},"capacity_total":{"type":"integer","description":"Total capacity reported by the peer."},"id":{"type":"integer","description":"Unique identifier."},"mgmt_connectivity_state":{"type":"string","description":"Current management-channel state, e.g. `ok`."},"mgmt_host":{"type":"string","description":"Management host (IP or DNS name) of the peer."},"name":{"type":"string","description":"Display name of the peer array."},"system_id":{"type":"string","description":"System identifier reported by the peer."},"username":{"type":"string","description":"Username used to authenticate against the peer."}}}}}}
```

## The ReplicationPeerVolumes object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"ReplicationPeerVolumes":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"local_volume":{"$ref":"#/components/schemas/Ref","description":"Reference to the local volume. Shape: `{ \"ref\": \"/volumes/{id}\" }`."},"name":{"type":"string","description":"Display name of the peer volume."},"remote_volume_id":{"type":"integer","description":"ID of the volume on the peer SDP."},"replication_peer_volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the parent peer volume group. Shape: `{ \"ref\": \"/replication/peer_volume_groups/{id}\" }`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The ReplicationPeerVolumeGroups object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"ReplicationPeerVolumeGroups":{"type":"object","properties":{"capacity_state":{"type":"string","description":"Capacity state reported for the peer volume group, e.g. `ok`."},"fullname":{"type":"string","description":"Fully qualified name including the peer system prefix (e.g. `d568_Dedup_vg`)."},"id":{"type":"integer","description":"Unique identifier."},"local_volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the local volume group paired with this peer. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."},"logical_capacity":{"type":"integer","description":"Logical capacity used."},"name":{"type":"string","description":"Short name of the peer volume group."},"remote_volume_group_id":{"type":"integer","description":"ID of the volume group on the peer."},"replication_peer_k2array":{"$ref":"#/components/schemas/Ref","description":"Reference to the peer array. Shape: `{ \"ref\": \"/replication/peer_k2arrays/{id}\" }`."},"replication_session":{"$ref":"#/components/schemas/Ref","description":"Reference to the replication session. Shape: `{ \"ref\": \"/replication/sessions/{id}\" }`."},"replication_session_id":{"type":"integer","description":"ID of the replication session."},"snapshots_logical_capacity":{"type":"integer","description":"Logical capacity attributed to snapshots."},"volumes_logical_capacity":{"type":"integer","description":"Logical capacity attributed to volumes."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The ReplicationPeerWanPorts object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"ReplicationPeerWanPorts":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"remote_wan_port_ip_address":{"type":"string","description":"IP address of the WAN port on the peer."},"remote_wan_port_name":{"type":"string","description":"Name of the WAN port on the peer."},"replication_peer_k2array":{"$ref":"#/components/schemas/Ref","description":"Reference to the peer array that owns this WAN port. Shape: `{ \"ref\": \"/replication/peer_k2arrays/{id}\" }`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The ReplicationRpoHistory object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"ReplicationRpoHistory":{"type":"object","properties":{"session":{"$ref":"#/components/schemas/Ref","description":"Reference to the replication session this history record belongs to. Shape: `{ \"ref\": \"/replication/sessions/{id}\" }`."},"generation_number":{"type":"integer","description":"Generation/round number for the session."},"role":{"type":"string","description":"Role of this SDP for the round, e.g. `target` or `source`."},"round_start":{"type":"integer","description":"Unix timestamp when the round started."},"round_end":{"type":"integer","description":"Unix timestamp when the round ended. `0` indicates the round has not yet completed."},"target_rpo":{"type":"integer","description":"Target RPO in seconds in effect for the round."},"bytes_transmitted_logical":{"type":"integer","description":"Logical bytes transmitted during the round."},"bytes_transmitted_physical":{"type":"integer","description":"Physical bytes transmitted during the round."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The ReplicationSessions object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"ReplicationSessions":{"type":"object","properties":{"common_snapshots_count":{"type":"integer","description":"Number of snapshots present on both sides."},"current_role":{"type":"string","description":"Role of this SDP for the session, e.g. `source` or `target`."},"current_snapshot":{"type":"string","nullable":true,"description":"Identifier of the snapshot currently being replicated."},"current_snapshot_progress":{"type":"integer","description":"Progress of the in-flight snapshot."},"estimated_remaining_time":{"type":"integer","nullable":true,"description":"Estimated seconds remaining on the in-flight transfer."},"external_retention_policy":{"$ref":"#/components/schemas/Ref","description":"Reference to the retention policy applied to snapshots on the peer. Shape: `{ \"ref\": \"/retention_policies/{id}\" }`."},"id":{"type":"integer","description":"Unique identifier."},"latest_replicated_snapshot":{"$ref":"#/components/schemas/Ref","description":"Reference to the most recently replicated snapshot. Shape: `{ \"ref\": \"/snapshots/{id}\" }`."},"local_volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the local volume group being replicated. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."},"name":{"type":"string","description":"Local session name."},"next_snapshot":{"type":"string","nullable":true,"description":"Identifier of the next snapshot queued for replication."},"primary":{"type":"boolean","description":"Whether this side is the primary."},"remote_replication_session_id":{"type":"integer","description":"ID of the matching session on the peer SDP."},"remote_replication_session_name":{"type":"string","description":"Name of the matching session on the peer SDP."},"replication_peer_k2array":{"$ref":"#/components/schemas/Ref","description":"Reference to the peer array. Shape: `{ \"ref\": \"/replication/peer_k2arrays/{id}\" }`."},"replication_peer_volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the peer volume group. Shape: `{ \"ref\": \"/replication/peer_volume_groups/{id}\" }`."},"replication_rpo_history":{"$ref":"#/components/schemas/Ref","description":"Reference to the RPO history collection for the session. Shape: `{ \"ref\": \"/replication/rpo_history/{id}\" }`."},"restored_snapshot":{"type":"string","nullable":true,"description":"Snapshot the session was last restored from."},"retention_policy":{"$ref":"#/components/schemas/Ref","description":"Reference to the local retention policy. Shape: `{ \"ref\": \"/retention_policies/{id}\" }`."},"rpo":{"type":"integer","description":"Target RPO in seconds."},"state":{"type":"string","description":"Current session state, e.g. `in_sync`."},"stopped":{"type":"boolean","description":"`true` if the session is stopped."},"suspend_reason":{"type":"string","description":"Free-form reason text when suspended."},"suspend_reason_code":{"type":"string","description":"Machine-readable suspend reason, e.g. `none`."},"target_exposure":{"type":"string","description":"Target-side exposure mode, e.g. `unmapped`."},"type":{"type":"string"}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The ReplicationStatsSystem object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"ReplicationStatsSystem":{"type":"object","properties":{"logical_in":{"type":"integer","description":"Logical bytes received during the resolution window."},"logical_out":{"type":"integer","description":"Logical bytes sent during the resolution window."},"physical_in":{"type":"integer","description":"Physical bytes received during the resolution window."},"physical_out":{"type":"integer","description":"Physical bytes sent during the resolution window."},"resolution":{"type":"integer","description":"Resolution of the sample, in seconds."},"timestamp":{"type":"integer","description":"Unix timestamp of the sample."}}}}}}
```

## The ReplicationStatsVolumes object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"ReplicationStatsVolumes":{"type":"object","properties":{"logical_in":{"type":"integer","description":"Logical bytes received during the resolution window."},"logical_out":{"type":"integer","description":"Logical bytes sent during the resolution window."},"physical_in":{"type":"integer","description":"Physical bytes received during the resolution window."},"physical_out":{"type":"integer","description":"Physical bytes sent during the resolution window."},"resolution":{"type":"integer","description":"Resolution of the sample, in seconds."},"timestamp":{"type":"integer","description":"Unix timestamp of the sample."},"volume":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume the sample describes. Shape: `{ \"ref\": \"/volumes/{id}\" }`."},"volume_name":{"type":"string","description":"Name of the volume."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The StatsSystem object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"StatsSystem":{"type":"object","properties":{"iops_avg":{"type":"integer","description":"Average IOPS over the sample window."},"iops_max":{"type":"integer","description":"Peak IOPS observed in the sample window."},"latency_inner":{"type":"number","description":"Average inner latency, in milliseconds."},"latency_outer":{"type":"number","description":"Average outer latency, in milliseconds."},"resolution":{"type":"integer","description":"Sample resolution, in seconds."},"throughput_avg":{"type":"integer","description":"Average throughput, in bytes per second."},"throughput_max":{"type":"integer","description":"Peak throughput observed, in bytes per second."},"timestamp":{"type":"integer","description":"Unix timestamp of the sample."}}}}}}
```

## The StatsVolumes object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"StatsVolumes":{"type":"object","properties":{"iops_avg":{"type":"integer","description":"Average IOPS over the sample window."},"iops_max":{"type":"integer","description":"Peak IOPS observed in the sample window."},"latency_inner":{"type":"number","description":"Average inner latency, in milliseconds."},"latency_outer":{"type":"number","description":"Average outer latency, in milliseconds."},"resolution":{"type":"integer","description":"Sample resolution, in seconds."},"throughput_avg":{"type":"integer","description":"Average throughput, in bytes per second."},"throughput_max":{"type":"integer","description":"Peak throughput observed, in bytes per second."},"timestamp":{"type":"integer","description":"Unix timestamp of the sample."},"volume":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume the sample describes. Shape: `{ \"ref\": \"/volumes/{id}\" }`."},"volume_name":{"type":"string","description":"Name of the volume."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The ProxySecureSsh object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"ProxySecureSsh":{"type":"object","properties":{"auto_enable":{"type":"boolean","description":"Whether the proxy auto-enables."},"https_port":{"type":"integer","nullable":true,"description":"HTTPS port exposed by the proxy."},"id":{"type":"integer","description":"Unique identifier."},"ip_address":{"type":"string","description":"Proxy IP address."},"pmc_comments":{"type":"string","nullable":true,"description":"Free-form notes for the PMC tunnel."},"pmc_ssh_port":{"type":"integer","nullable":true,"description":"SSH port mapped to the PMC."},"smc_comments":{"type":"string","nullable":true,"description":"Free-form notes for the SMC tunnel."},"smc_ssh_port":{"type":"integer","nullable":true,"description":"SSH port mapped to the SMC."},"status":{"type":"string","description":"Tunnel status, e.g. `Disabled`."},"time_remaining":{"type":"integer","nullable":true,"description":"Seconds remaining until the tunnel auto-disables."}}}}}}
```

## The StaticRoutes object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"StaticRoutes":{"type":"object","properties":{"destination_subnet_ip":{"type":"string","description":"Destination subnet IP address."},"destination_subnet_mask":{"type":"string","description":"Destination subnet mask."},"gateway_ip":{"type":"string","description":"Next-hop gateway IP address."},"knode":{"type":"string","description":"Knode the route applies to."},"id":{"type":"integer","description":"Unique identifier."}}}}}}
```

## The SystemCapacity object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemCapacity":{"type":"object","properties":{"allocated":{"type":"integer","description":"Total allocated capacity."},"allocated_snapshots_and_views":{"type":"integer","description":"Allocated capacity for snapshots and views combined."},"allocated_volumes":{"type":"integer","description":"Allocated capacity for volumes."},"free":{"type":"integer","description":"Free capacity available for new provisioning."},"id":{"type":"integer","description":"Unique identifier."},"is_reclamation_in_progress":{"type":"boolean","description":"`true` while the SDP is reclaiming freed capacity."},"logical":{"type":"integer","description":"Logical capacity consumed."},"max_logical":{"type":"integer"},"physical":{"type":"integer","description":"Physical capacity consumed."},"provisioned":{"type":"integer","description":"Total provisioned capacity across volumes, snapshots, and views."},"provisioned_snapshots":{"type":"integer","description":"Provisioned capacity for snapshots."},"provisioned_views":{"type":"integer","description":"Provisioned capacity for views."},"provisioned_volumes":{"type":"integer","description":"Provisioned capacity for volumes."},"reserved":{"type":"integer","description":"Capacity held in reserve and not available to volumes."},"state":{"type":"string","description":"Capacity state, e.g. `ok`."},"total":{"type":"integer","description":"Total raw capacity."}}}}}}
```

## The SystemCapacityPolicy object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemCapacityPolicy":{"type":"object","properties":{"critical_threshold":{"type":"integer","description":"Percentage at which a critical alert is raised."},"error_threshold":{"type":"integer","description":"Percentage at which an error is raised."},"full_threshold":{"type":"integer","description":"Percentage that represents capacity-full."},"id":{"type":"integer","description":"Unique identifier."},"num_snapshots":{"type":"integer","description":"Number of snapshots retained per source."},"warning_threshold":{"type":"integer","description":"Percentage at which a warning is raised."}}}}}}
```

## The SystemDecommission object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemDecommission":{"type":"object","properties":{"disk_group":{"$ref":"#/components/schemas/Ref"},"disk_group_id":{"type":"integer"},"id":{"type":"integer"},"mnode_name":{"type":"string"},"new_primary":{"$ref":"#/components/schemas/Ref"},"new_primary_id":{"type":"integer"},"progress":{"type":"integer"},"stage":{"type":"string"}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemDiskGroups object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemDiskGroups":{"type":"object","properties":{"bcache_supported":{"type":"boolean"},"cur_raid_level":{"type":"integer"},"disk_rebuild_priority_list":{"type":"string"},"id":{"type":"integer","description":"Unique identifier."},"is_expansion_in_progress":{"type":"boolean","description":"`true` while a system expansion affecting this disk group is in progress."},"is_primary":{"type":"boolean"},"max_raid_level":{"type":"integer"},"name":{"type":"string","description":"Disk group name (e.g. `kblock01-disk-group-00`)."},"raid_level":{"type":"string","description":"RAID level used by the disk group, e.g. `K_RAID`."}}}}}}
```

## The SystemExpansion object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemExpansion":{"type":"object","properties":{"component":{"type":"string"},"estimated_time":{"type":"integer","nullable":true,"description":"Estimated time remaining, or `null` when idle."},"id":{"type":"integer","description":"Unique identifier."},"message":{"type":"string"},"overall_progress":{"type":"integer"},"progress":{"type":"integer","description":"Progress percentage, `0`-`100`."},"stage":{"type":"string","description":"Current stage of the expansion, e.g. `None`."},"state":{"type":"string","description":"Overall expansion state, e.g. `Idle`."},"sub_stage":{"type":"string"},"tag":{"type":"string"},"type":{"type":"string","nullable":true,"description":"Type of expansion in progress, or `null` when idle."}}}}}}
```

## The SystemJbods object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemJbods":{"type":"object","properties":{"connectivity_state":{"$ref":"#/components/schemas/Ref","description":"Reference to the hardware state describing the shelf's connectivity. Shape: `{ \"ref\": \"/system/hardware_states/{id}\" }`."},"contained_in":{"$ref":"#/components/schemas/Ref","description":"Reference to the parent c-node pair. Shape: `{ \"ref\": \"/system/pairs/{id}\" }`."},"id":{"type":"integer","description":"Unique identifier."},"is_expansion_in_progress":{"type":"boolean","description":"`true` while a system expansion affecting this shelf is in progress."},"is_fru":{"type":"boolean","description":"`true` if the shelf is a field-replaceable unit."},"is_phased_out":{"type":"boolean","description":"`true` if the shelf has been phased out."},"name":{"type":"string","description":"Shelf name (e.g. `kblock01-shelf01`)."},"ndu_state":{"type":"string","description":"Non-disruptive-upgrade state, e.g. `component upgrade idle`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemLdapServers object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemLdapServers":{"type":"object","properties":{"base_dn":{"type":"string"},"fqdn":{"type":"string"},"group_mapped_to_admin":{"type":"string"},"group_mapped_to_viewer":{"type":"string"},"id":{"type":"integer"},"port":{"type":"integer"},"type":{"type":"string"},"uri":{"type":"string"},"use_ssl":{"type":"boolean"},"user_dn":{"type":"string"}}}}}}
```

## The SystemLocalStorageDevs object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemLocalStorageDevs":{"type":"object","properties":{"connectivity_state":{"$ref":"#/components/schemas/Ref","description":"Reference to the hardware state describing the device's connectivity. Shape: `{ \"ref\": \"/system/hardware_states/{id}\" }`."},"contained_in":{"$ref":"#/components/schemas/Ref","description":"Reference to the parent server. Shape: `{ \"ref\": \"/system/servers/{id}\" }`."},"id":{"type":"integer","description":"Unique identifier."},"is_expansion_in_progress":{"type":"boolean","description":"`true` while a system expansion affecting this component is in progress."},"is_fru":{"type":"boolean","description":"`true` if the device is a field-replaceable unit."},"is_phased_out":{"type":"boolean","description":"`true` if the device has been phased out."},"name":{"type":"string","description":"Device name (e.g. `kblock01-knode01-storage02`)."},"ndu_state":{"type":"string","description":"Non-disruptive-upgrade state, e.g. `component upgrade idle`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemNdu object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemNdu":{"type":"object","properties":{"background_fw_update":{"type":"boolean","description":"`true` while a background firmware update is running."},"id":{"type":"integer","description":"Unique identifier."},"ndu_state":{"type":"string","description":"NDU state, e.g. `ndu idle`."},"new_version":{"type":"integer","nullable":true,"description":"Target version, if an NDU is active."},"old_version":{"type":"integer","nullable":true,"description":"Source version, if an NDU is active."},"operation":{"type":"string","description":"Operation type, e.g. `upgrade`."}}}}}}
```

## The SystemNetInterfaces object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemNetInterfaces":{"type":"object","properties":{"eth_name":{"type":"string","description":"Underlying OS interface name (e.g. `eth3`, `ib0`)."},"id":{"type":"integer","description":"Unique identifier."},"if_ip":{"type":"string","description":"IPv4 address bound to the interface."},"is_expansion_in_progress":{"type":"boolean","description":"`true` while the interface is being reconfigured as part of an expansion operation."},"name":{"type":"string","description":"Interface name (e.g. `c-node04_netif-mgmt01`)."},"port":{"$ref":"#/components/schemas/Ref","description":"Reference to the underlying physical port. Shape: `{ \"ref\": \"/system/net_ports/{id}\" }`."},"port_type":{"type":"string","description":"Logical role of the interface, e.g. `netif-mgmt` or `netif-external`."},"server":{"$ref":"#/components/schemas/Ref","description":"Reference to the server the interface lives on. Shape: `{ \"ref\": \"/system/servers/{id}\" }`."},"status":{"type":"string","description":"Interface status, e.g. `ok`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemNetIps object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemNetIps":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"ip_address":{"type":"string","description":"IPv4 address."},"net_port":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the underlying physical network port, when the IP is bound directly to a port. Shape: `{ \"ref\": \"/system/net_ports/{id}\" }`."},"net_portchannel":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound port channel, if any. Shape: `{ \"ref\": \"/system/net_portchannels/{id}\" }`."},"net_vlan":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound VLAN interface, if any. Shape: `{ \"ref\": \"/system/net_vlans/{id}\" }`."},"network_mask":{"type":"string","description":"IPv4 network mask in dotted-decimal form."},"nvme_port":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound NVMe port, if any."},"wan_port":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound WAN port, if any. Shape: `{ \"ref\": \"/system/wan_ports/{id}\" }`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemNetPorts object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemNetPorts":{"type":"object","properties":{"contained_in":{"$ref":"#/components/schemas/Ref","description":"Reference to the parent hardware element. Shape: `{ \"ref\": \"/system/servers/{id}\" }`."},"flow_control":{"type":"boolean","nullable":true,"description":"Whether flow control is enabled."},"id":{"type":"integer","description":"Unique identifier."},"is_fru":{"type":"boolean","description":"`true` if the port is a field-replaceable unit."},"link_state":{"$ref":"#/components/schemas/Ref","description":"Reference to the hardware-state record reporting link state. Shape: `{ \"ref\": \"/system/hardware_states/{id}\" }`."},"mac_addr":{"type":"string","description":"MAC address."},"mtu":{"type":"string","nullable":true,"description":"MTU configured on the port, when applicable."},"name":{"type":"string","description":"Port name (e.g. `c-node04_dataport01`)."},"port_type":{"type":"string","description":"Port role, e.g. `dataport`, `mgmtport`, `ib`."},"server":{"$ref":"#/components/schemas/Ref","description":"Reference to the server the port lives on. Shape: `{ \"ref\": \"/system/servers/{id}\" }`."},"speed_state":{"$ref":"#/components/schemas/Ref","description":"Reference to the hardware-state record reporting negotiated link speed. Shape: `{ \"ref\": \"/system/hardware_states/{id}\" }`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemPairs object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemPairs":{"type":"object","properties":{"id":{"type":"integer"},"is_expansion_in_progress":{"type":"boolean"},"is_fru":{"type":"boolean"},"is_phased_out":{"type":"boolean"},"name":{"type":"string"},"ndu_state":{"type":"string"}}}}}}
```

## The SystemPartialSystemParameters object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemPartialSystemParameters":{"type":"object","properties":{"_dbg_self_replication_enabled":{"type":"boolean"},"available_host_connectivity_type":{"type":"string"},"checkpointing_mode":{"type":"string"},"customer_info":{"type":"string"},"default_dataport_mtu_size":{"type":"integer"},"default_gateway":{"nullable":true},"dns_server1":{"type":"string"},"dns_server2":{"type":"string"},"dns_server3":{"type":"string"},"enable_flex_mode":{"type":"boolean"},"environment":{"type":"string"},"external_ip":{"type":"string"},"external_mask":{"type":"string"},"fe.max_num_of_lus":{"type":"integer"},"files_sending_protocol":{"type":"string"},"global_iscsi_target_name":{"type":"string"},"id":{"type":"integer"},"ipmi_ip_prefix":{"type":"string"},"ipmi_subnet_mask":{"type":"string"},"m1_ip_prefix":{"type":"string"},"m2_ip_prefix":{"type":"string"},"max_cascading_depth":{"type":"integer"},"max_dataport_mtu_size":{"type":"integer"},"max_host_name_length":{"type":"integer"},"max_lu_desc_length":{"type":"integer"},"max_lu_name_length":{"type":"integer"},"max_lu_size":{"type":"integer"},"max_num_host_luns":{"type":"integer"},"max_num_of_base_vols":{"type":"integer"},"max_num_of_capacity_policy_snapshots":{"type":"integer"},"max_num_of_exposeable_volsnaps":{"type":"integer"},"max_num_of_host_groups":{"type":"integer"},"max_num_of_hosts":{"type":"integer"},"max_num_of_replication_base_vols":{"type":"integer"},"max_num_of_replication_retention_snaps_per_vg":{"type":"integer"},"max_num_of_replication_vgs":{"type":"integer"},"max_num_of_retention_policies":{"type":"integer"},"max_num_of_schedulers":{"type":"integer"},"max_num_of_snaps_per_vg":{"type":"integer"},"max_num_of_syslog_servers":{"type":"integer"},"max_num_of_vg_capacity_policies":{"type":"integer"},"max_num_of_vgs":{"type":"integer"},"max_num_of_views_per_snapshot":{"type":"integer"},"max_num_of_vlans":{"type":"integer"},"max_num_of_volumes_per_vg":{"type":"integer"},"max_object_name_length":{"type":"integer"},"max_replication_targets":{"type":"integer"},"max_retention_policy_name_length":{"type":"integer"},"max_rpo":{"type":"integer"},"max_scheduler_name_length":{"type":"integer"},"max_vlan_tag":{"type":"integer"},"min_capacity_policy_threshold_interval_percentage":{"type":"integer"},"min_dataport_mtu_size":{"type":"integer"},"min_lu_size":{"type":"integer"},"min_rpo":{"type":"integer"},"min_vg_quota":{"type":"integer"},"min_vg_quota_in_bytes":{"type":"integer"},"min_vlan_tag":{"type":"integer"},"product_id":{"type":"string"},"replication_max_bandwidth":{"type":"integer"},"sender_email":{"nullable":true},"smtp_auth":{"nullable":true},"smtp_port":{"nullable":true},"smtp_sec":{"nullable":true},"smtp_server":{"nullable":true},"smtp_user":{"nullable":true},"system_id":{"type":"string"},"thin_clone_max_depth":{"type":"integer"}}}}}}
```

## The SystemServerJbodConnectionSsdDevMaps object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemServerJbodConnectionSsdDevMaps":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"is_expansion_in_progress":{"type":"boolean","description":"`true` while a system expansion affects this mapping."},"server_jbod_connection":{"$ref":"#/components/schemas/Ref","description":"Reference to the underlying server-to-JBOD connection. Shape: `{ \"ref\": \"/system/server_jbod_connections/{id}\" }`."},"ssd_dev":{"$ref":"#/components/schemas/Ref","description":"Reference to the SSD device. Shape: `{ \"ref\": \"/system/ssd_devs/{id}\" }`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemServerJbodConnections object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemServerJbodConnections":{"type":"object","properties":{"id":{"type":"integer"},"is_expansion_in_progress":{"type":"boolean"},"jbod":{"$ref":"#/components/schemas/Ref"},"server":{"$ref":"#/components/schemas/Ref"}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemServerJbodExpanderConnections object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemServerJbodExpanderConnections":{"type":"object","properties":{"contained_in":{"$ref":"#/components/schemas/Ref"},"id":{"type":"integer"},"is_expansion_in_progress":{"type":"boolean"},"is_fru":{"type":"boolean"},"is_phased_out":{"type":"boolean"},"name":{"type":"string"},"ndu_state":{"type":"string"}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemServers object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemServers":{"type":"object","properties":{"contained_in":{"$ref":"#/components/schemas/Ref","description":"Reference to the parent pair. Shape: `{ \"ref\": \"/system/pairs/{id}\" }`."},"display_name":{"type":"string","description":"Display name; empty when unset."},"fru_type":{"type":"string","description":"Field-replaceable-unit type, e.g. `SM-SRV-F`."},"id":{"type":"integer","description":"Unique identifier."},"is_expansion_in_progress":{"type":"boolean","description":"`true` while a system expansion affects this server."},"is_fru":{"type":"boolean","description":"`true` when the server is itself a FRU."},"is_phased_out":{"type":"boolean","description":"`true` when the server has been phased out."},"is_phasing_in":{"type":"boolean","description":"`true` while the server is being phased in."},"name":{"type":"string","description":"Server name (e.g. `kblock01-knode01`)."},"ndu_state":{"type":"string","description":"NDU state, e.g. `component upgrade idle`."},"status":{"type":"string","description":"Overall status, e.g. `ok`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemSnapshotCapacityCalculation object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemSnapshotCapacityCalculation":{"type":"object","properties":{"capacity":{"type":"integer"},"capacity_in_lb":{"type":"integer"},"description":{"type":"string"},"end_ts":{"type":"string"},"end_ts_epoch":{"type":"integer"},"estimated_time":{"type":"integer"},"id":{"type":"integer"},"name":{"type":"string"},"snapshots_and_views":{"type":"array","items":{"type":"string"}},"start_ts":{"type":"string"},"start_ts_epoch":{"type":"integer"},"state":{"type":"string"},"status":{"type":"string"},"volume_group":{"type":"string"}}}}}}
```

## The SystemSoftwareStates object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemSoftwareStates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"is_valid":{"type":"boolean"},"name":{"type":"string","description":"Subsystem or indicator name, e.g. `SMTP connectivity`."},"severity":{"type":"string","description":"Severity, e.g. `ok`, `warning`, `error`."},"status":{"type":"string","description":"Current status, e.g. `ok`."},"status_msg":{"type":"string","description":"Free-form status message; empty when nothing to report."}}}}}}
```

## The SystemSsdDevs object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemSsdDevs":{"type":"object","properties":{"connectivity_state":{"$ref":"#/components/schemas/Ref","description":"Reference to the hardware state describing the SSD's connectivity. Shape: `{ \"ref\": \"/system/hardware_states/{id}\" }`."},"contained_in":{"$ref":"#/components/schemas/Ref","description":"Reference to the enclosing component. Shape: `{ \"ref\": \"/system/jbods/{id}\" }`."},"disk_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the disk group this SSD belongs to. Shape: `{ \"ref\": \"/system/disk_groups/{id}\" }`."},"disk_rebuild_progress_percentage":{"type":"integer"},"disk_rebuild_retries":{"type":"integer"},"dnode_auto_replacement_retries":{"type":"integer"},"dnode_index":{"type":"integer"},"dnode_version":{"nullable":true},"encryption_support":{"type":"boolean","description":"`true` if the SSD supports encryption."},"id":{"type":"integer","description":"Unique identifier."},"is_dnode_time_synced":{"type":"boolean"},"is_expansion_in_progress":{"type":"boolean","description":"`true` while a system expansion affecting this SSD is in progress."},"is_fru":{"type":"boolean","description":"`true` if the SSD is a field-replaceable unit."},"is_phased_out":{"type":"boolean","description":"`true` if the SSD has been phased out."},"jbod":{"$ref":"#/components/schemas/Ref","description":"Reference to the JBOD shelf this SSD is in. Shape: `{ \"ref\": \"/system/jbods/{id}\" }`."},"name":{"type":"string","description":"SSD name (e.g. `kblock01-shelf01-storage24`)."},"ndu_state":{"type":"string","description":"Non-disruptive-upgrade state, e.g. `component upgrade idle`."},"size":{"type":"integer","description":"SSD capacity."},"srl_health":{"type":"integer","description":"SSD reliability/health metric."},"vm_type":{"nullable":true}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemState object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemState":{"type":"object","properties":{"current_user_role":{"type":"string","description":"The effective role of the authenticated caller, e.g. `admin`."},"id":{"type":"integer","description":"Unique identifier."},"is_system_functionality_degraded":{"type":"boolean","description":"`true` when the SDP is running in a degraded mode."},"iscsi_qualified_target_name":{"type":"string","description":"The SDP's iSCSI IQN."},"last_online_time":{"type":"number","description":"Unix timestamp of the most recent online transition."},"next_state":{"type":"string","description":"Pending state transition, or `\"None\"` when none."},"replication_default_target_exposure":{"type":"string","description":"Default exposure mode for replication targets, e.g. `unmapped`."},"replication_min_protocol_version":{"type":"integer","description":"Minimum replication protocol version supported."},"replication_protocol_version":{"type":"integer","description":"Replication protocol version in use."},"rest_api_version":{"type":"string","description":"REST API version, e.g. `2.2.0`."},"sra_protocol_version":{"type":"string","description":"SRA protocol version."},"state":{"type":"string","description":"Current state, e.g. `ONLINE`."},"system_connectivity_type":{"type":"string","description":"Host-facing connectivity, e.g. `FC`."},"system_id":{"type":"string","description":"System ID, e.g. `d575`."},"system_name":{"type":"string","description":"System display name."},"system_time":{"type":"number","description":"Current system time, Unix timestamp."},"system_tz":{"type":"string","description":"IANA time zone, e.g. `Asia/Jerusalem`."},"system_tz_short":{"type":"string","description":"Short time-zone abbreviation, e.g. `IST`."},"system_version":{"type":"string","description":"Build version string."}}}}}}
```

## The SystemStaticRouteIscsiPortMapper object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemStaticRouteIscsiPortMapper":{"type":"object","properties":{"id":{"type":"integer"},"iscsi_port":{"$ref":"#/components/schemas/Ref"},"iscsi_port_id":{"type":"integer"},"static_route":{"$ref":"#/components/schemas/Ref"},"static_route_id":{"type":"integer"}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemStaticRouteNetInterfacePortMapper object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemStaticRouteNetInterfacePortMapper":{"type":"object","properties":{"id":{"type":"integer"},"net_interface":{"$ref":"#/components/schemas/Ref"},"netif_external":{"type":"object","properties":{"id":{"type":"integer"},"table_name":{"type":"string"}}},"netif_external_id":{"type":"integer"},"static_route":{"$ref":"#/components/schemas/Ref"},"static_route_id":{"type":"integer"}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemStaticRouteWanPortMapper object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemStaticRouteWanPortMapper":{"type":"object","properties":{"id":{"type":"integer"},"static_route":{"$ref":"#/components/schemas/Ref"},"static_route_id":{"type":"integer"},"wan_port":{"$ref":"#/components/schemas/Ref"},"wan_port_id":{"type":"integer"}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SystemSyslogServers object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemSyslogServers":{"type":"object","properties":{"address":{"type":"string","description":"Syslog server address (IP or hostname)."},"id":{"type":"integer","description":"Unique identifier."},"is_connected":{"type":"boolean","description":"`true` when the SDP currently has connectivity to the syslog server."},"port":{"type":"integer","description":"Destination port (commonly `514`)."},"report_audit":{"type":"boolean","description":"`true` to forward audit events."},"type":{"type":"string","description":"Syslog format/type, e.g. `standard`."},"use_tcp":{"type":"boolean","description":"`true` to use TCP transport; `false` for UDP."}}}}}}
```

## The SystemTargetIqns object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemTargetIqns":{"type":"object","properties":{"id":{"type":"integer"},"iqn":{"type":"string"}}}}}}
```

## The SystemWanConnections object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SystemWanConnections":{"type":"object","properties":{"connected_pct":{"type":"integer"},"highavail_pct":{"type":"integer"},"id":{"type":"integer"},"is_activated":{"type":"boolean"},"local_server":{"$ref":"#/components/schemas/Ref"},"replication_peer_k2array":{"$ref":"#/components/schemas/Ref"},"replication_peer_wan_port":{"$ref":"#/components/schemas/Ref"},"wan_path_1":{"type":"object","properties":{"id":{"type":"integer"},"table_name":{"type":"string"}}},"wan_path_2":{"type":"object","properties":{"id":{"type":"integer"},"table_name":{"type":"string"}}}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The TargetAuth object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"TargetAuth":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string"},"username":{"type":"string"}}}}}}
```

## The Users object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"Users":{"type":"object","properties":{"disabled":{"type":"boolean"},"id":{"type":"integer"},"role_name":{"type":"string"},"status":{"type":"boolean"},"username":{"type":"string"}}}}}}
```

## The Volumes object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"Volumes":{"type":"object","properties":{"avg_compressed_ratio":{"type":"number","description":"Average compression ratio."},"avg_compressed_ratio_timestamp":{"type":"integer","description":"Timestamp of the last compression-ratio computation."},"clones_count":{"type":"integer"},"creation_time":{"type":"integer","description":"Unix timestamp the volume was created."},"current_replication_stats":{"$ref":"#/components/schemas/Ref","description":"Live replication stats endpoint, if applicable."},"current_stats":{"$ref":"#/components/schemas/Ref","description":"Live performance stats endpoint for this volume."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"id":{"type":"integer","description":"Unique identifier."},"is_dedup":{"type":"boolean","description":"Whether deduplication is enabled."},"is_new":{"type":"boolean","description":"`true` for newly created volumes that have not yet served data."},"iscsi_tgt_converted_name":{"type":"string","description":"Target name used for iSCSI exposure."},"last_restored_from":{"type":"integer","nullable":true,"description":"ID of the snapshot the volume was last restored from."},"last_restored_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the last restore."},"logical_capacity":{"type":"integer","description":"Logical capacity consumed, in kilobytes."},"marked_for_deletion":{"type":"boolean","description":"`true` when the volume is in the process of being removed."},"name":{"type":"string","description":"Display name."},"node_id":{"type":"integer","description":"Internal node assignment."},"read_only":{"type":"boolean","description":"`true` for read-only exposure."},"replication_peer_volume":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"When the volume is the source of a replication session, this points at the peer volume on the remote SDP. Shape: `{ \"ref\": \"/replication/peer_volumes/{id}\" }`."},"scsi_sn":{"type":"string","description":"SCSI serial number assigned by the SDP."},"scsi_suffix":{"type":"integer","description":"Numeric suffix component of the serial."},"size":{"type":"integer","description":"Provisioned size, in kilobytes."},"snapshots_logical_capacity":{"type":"integer","description":"Logical capacity consumed by snapshots associated with the volume."},"source_snap":{"$ref":"#/components/schemas/Ref"},"source_snap_id":{"type":"integer"},"historic_source_snap_id":{"type":"integer"},"full_clone":{"type":"object","properties":{"state_text":{"type":"string"},"progress":{"type":"integer"},"stop_reason_text":{"type":"string"}}},"stream_avg_compressed_size_in_bytes":{"type":"number","description":"Average compressed stream size, in bytes."},"vmware_support":{"type":"boolean","description":"`true` enables VMFS-friendly behavior. Set this when the volume will host a VMware datastore."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the parent volume group. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`. Required at creation time; changeable via PATCH to move the volume to another group."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The VolumeGroups object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"VolumeGroups":{"type":"object","properties":{"capacity_policy":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to a `vg_capacity_policy` if one is attached. Shape: `{ \"ref\": \"/vg_capacity_policies/{id}\" }`."},"capacity_state":{"type":"string","description":"Overall capacity health. `ok` when within bounds."},"clones_count":{"type":"integer"},"creation_time":{"type":"number","description":"Unix timestamp the group was created."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"id":{"type":"integer","description":"Unique identifier."},"is_dedup":{"type":"boolean","description":"Whether deduplication is enabled at the group level."},"is_default":{"type":"boolean","description":"`true` for the SDP's built-in default volume group."},"iscsi_tgt_converted_name":{"type":"string","description":"Target name used for iSCSI exposure."},"last_restored_from":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the snapshot the group was last restored from. Shape: `{ \"ref\": \"/snapshots/{id}\" }`."},"last_restored_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the last restore."},"last_snapshot_creation_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the most recent snapshot of this group."},"logical_capacity":{"type":"number","description":"Logical capacity consumed by member volumes."},"mapped_hosts_count":{"type":"integer","description":"Number of hosts that map at least one volume from this group."},"name":{"type":"string","description":"Display name."},"quota":{"type":"integer","nullable":true,"description":"Capacity cap on this volume group, in kilobytes. `null` means unlimited."},"replication_peer_volume_group":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the corresponding volume group on the peer SDP."},"replication_rpo_history":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the RPO history endpoint."},"replication_session":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the replication session, if the group is replicated."},"snapshots_count":{"type":"integer","description":"Number of snapshots associated with the group."},"snapshots_logical_capacity":{"type":"integer","description":"Logical capacity occupied by snapshots associated with this group."},"snapshots_overhead_state":{"type":"string","description":"Health indicator for snapshot overhead. `ok` when within bounds."},"source_snap_id":{"nullable":true},"source_snap":{"nullable":true},"views_count":{"type":"integer","description":"Number of views currently exposed."},"volumes_count":{"type":"integer","description":"Number of volumes in the group."},"volumes_logical_capacity":{"type":"integer","description":"Logical capacity occupied by member volumes only (excluding snapshots)."},"volumes_provisioned_capacity":{"type":"integer","description":"Total provisioned size of member volumes."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The Snapshots object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"Snapshots":{"type":"object","properties":{"creation_time":{"type":"number","description":"Unix timestamp the snapshot was taken."},"data_creation_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the underlying data, distinct from when the metadata record was written."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"generation_number":{"type":"integer","nullable":true,"description":"Per-source counter."},"id":{"type":"integer","description":"Unique identifier."},"is_application_consistent":{"type":"boolean","nullable":true,"description":"`true` when the snapshot was taken with application coordination."},"is_auto_deleteable":{"type":"boolean","description":"`true` if the SDP may auto-delete this record under retention policy."},"is_deleted":{"type":"boolean","description":"`true` once the SDP has marked the record for deletion (it may still be visible briefly)."},"is_exist_on_peer":{"type":"boolean","description":"`true` if the snapshot also exists on a replication peer."},"is_exposable":{"type":"boolean","description":"`true` for views (mappable like a volume), `false` for ordinary snapshots."},"is_external":{"type":"boolean","nullable":true,"description":"`true` if originated from outside the local SDP."},"is_originating_from_peer":{"type":"boolean","nullable":true,"description":"`true` if originated from a replication peer."},"iscsi_tgt_converted_name":{"type":"string","description":"Target name used for iSCSI exposure of an exposable view."},"last_exposed_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the most recent exposure event (views only)."},"name":{"type":"string","description":"Full computed name (`{volume_group}:{short_name}`)."},"replication_session":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the replication session, when applicable."},"retention_policy":{"$ref":"#/components/schemas/Ref","description":"Reference to the retention policy governing this snapshot. Shape: `{ \"ref\": \"/retention_policies/{id}\" }`."},"short_name":{"type":"string","description":"The portion supplied at creation."},"source":{"$ref":"#/components/schemas/Ref","description":"What this snapshot was taken from. - For a snapshot: `{ \"ref\": \"/volume_groups/{id}\" }`. - For a view: `{ \"ref\": \"/snapshots/{id}\" }` (the parent snapshot)."},"triggered_by":{"type":"string","description":"Origin of the create action, e.g. `api`, `scheduler`, `replication`."},"volsnaps_provisioned_capacity":{"type":"integer","description":"Provisioned capacity attributed to the snapshot, in kilobytes."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume group the snapshot ultimately belongs to. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."},"wwn":{"type":"string","nullable":true,"description":"WWN assigned to the snapshot/view."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SnapshotScheduler object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SnapshotScheduler":{"type":"object","properties":{"description":{"type":"string","nullable":true,"description":"Free-form description."},"id":{"type":"integer","description":"Unique identifier."},"is_enabled":{"type":"boolean","description":"`true` when the scheduler is actively producing snapshots."},"name":{"type":"string","description":"Scheduler name."},"retention_policy":{"$ref":"#/components/schemas/Ref","description":"Reference to the retention policy applied to snapshots created by this scheduler. Shape: `{ \"ref\": \"/retention_policies/{id}\" }`."},"start_time":{"type":"number","description":"Unix timestamp at which the schedule begins."},"time_interval_min":{"type":"integer","description":"Snapshot interval, in minutes."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The SnapshotSchedulerMapping object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"SnapshotSchedulerMapping":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"last_successful_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the last successful run."},"snapshot_scheduler":{"$ref":"#/components/schemas/Ref","description":"Reference to the scheduler. Shape: `{ \"ref\": \"/snapshot_scheduler/{id}\" }`."},"status":{"type":"string","nullable":true,"description":"Status of the most recent run."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume group being snapshotted. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The RetentionPolicies object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"RetentionPolicies":{"type":"object","properties":{"days":{"type":"integer","description":"Retention duration component, in days."},"hours":{"type":"integer","description":"Retention duration component, in hours."},"id":{"type":"integer","description":"Unique identifier."},"name":{"type":"string","description":"Display name."},"num_snapshots":{"type":"integer","description":"Maximum number of snapshots to retain."},"snapshots_usage_count":{"type":"integer","description":"Number of snapshots currently bound to this retention policy."},"weeks":{"type":"integer","description":"Retention duration component, in weeks."}}}}}}
```

## The VgCapacityPolicies object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"VgCapacityPolicies":{"type":"object","properties":{"critical_threshold":{"type":"integer","description":"Percentage at which the policy raises a critical alert."},"error_threshold":{"type":"integer","description":"Percentage at which the policy raises an error."},"full_threshold":{"type":"integer","description":"Percentage at which the volume group is considered full."},"id":{"type":"integer","description":"Unique identifier."},"is_default":{"type":"boolean","description":"`true` when this is the system default capacity policy."},"name":{"type":"string","description":"Display name."},"num_snapshots":{"type":"integer","description":"Snapshot count threshold."},"snapshot_overhead_threshold":{"type":"integer","description":"Percentage threshold for snapshot overhead."},"warning_threshold":{"type":"integer","description":"Percentage at which the policy raises a warning."}}}}}}
```

## The Volsnaps object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"Volsnaps":{"type":"object","properties":{"creation_time":{"type":"number","description":"Unix timestamp the volsnap was created."},"id":{"type":"integer","description":"Unique identifier."},"is_deleted":{"type":"boolean","description":"`true` once the SDP has marked the record for deletion."},"is_exposable":{"type":"boolean","description":"`true` when the volsnap belongs to a view (mappable like a volume)."},"iscsi_tgt_converted_name":{"type":"string","description":"Target name used for iSCSI exposure."},"name":{"type":"string","description":"Full computed name (`{volume_group}:{snapshot}:{volume}`)."},"scsi_sn":{"type":"string","description":"SCSI serial number."},"scsi_suffix":{"type":"integer","description":"Numeric suffix component of the serial."},"short_name":{"type":"string","description":"Short name component."},"snapshot":{"$ref":"#/components/schemas/Ref","description":"Reference to the parent snapshot record. Shape: `{ \"ref\": \"/snapshots/{id}\" }`."},"source":{"$ref":"#/components/schemas/Ref","description":"Reference to the source volume the volsnap was taken from. Shape: `{ \"ref\": \"/volumes/{id}\" }`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]}}}}
```

## The UserTags object

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"components":{"schemas":{"UserTags":{"type":"object","properties":{"id":{"type":"integer"},"is_automatic":{"type":"boolean"},"is_inheritable":{"type":"boolean"},"key":{"type":"string"},"object_id":{"type":"integer"},"object_type":{"type":"string"},"value":{"type":"string"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.silk.us/api-reference/endpoints/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
