> 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/system-configuration/system-state.md).

# System state

The system's current state and basic information, such as its name, software version, time zone, and iSCSI target name.

Use this endpoint as a quick health and version check, or to rename the system.

## GET /system/state

> Get system state

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"System state","description":"The system's current state and basic information, such as its name, software version, time zone, and iSCSI target name.\n\nUse this endpoint as a quick health and version check, or to rename the system."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"parameters":{"limit":{"name":"__limit","in":"query","schema":{"type":"integer"},"description":"Caps the number of returned entities. Requires a sort parameter when paging."},"offset":{"name":"__offset","in":"query","schema":{"type":"integer"},"description":"Returns results starting from this offset. Requires a sort parameter when paging."},"sort":{"name":"__sort","in":"query","schema":{"type":"string"},"description":"Comma-separated object properties to sort by."},"sort_order":{"name":"__sort_order","in":"query","schema":{"type":"string","enum":["asc","desc"]},"description":"Sort direction."}},"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."}}},"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."}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/state":{"get":{"tags":["System state"],"summary":"Get system state","operationId":"listSystemState","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/sort_order"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Collection"},{"type":"object","properties":{"hits":{"type":"array","items":{"$ref":"#/components/schemas/SystemState"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## GET /system/state/{id}

> Get system state by ID

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"System state","description":"The system's current state and basic information, such as its name, software version, time zone, and iSCSI target name.\n\nUse this endpoint as a quick health and version check, or to rename the system."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"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."}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/state/{id}":{"get":{"tags":["System state"],"summary":"Get system state by ID","operationId":"getSystemState","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemState"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## PATCH /system/state/{id}

> Rename system

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"System state","description":"The system's current state and basic information, such as its name, software version, time zone, and iSCSI target name.\n\nUse this endpoint as a quick health and version check, or to rename the system."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"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."}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/state/{id}":{"patch":{"tags":["System state"],"summary":"Rename system","operationId":"updateSystemState","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Rename system","properties":{"system_name":{"type":"string","description":"System display name."}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemState"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```


---

# 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/system-configuration/system-state.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.
