You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/developers/operations-api/system-operations.md
+104Lines changed: 104 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,3 +61,107 @@ _Operation is restricted to super_user roles only_
61
61
"operation": "system_information"
62
62
}
63
63
```
64
+
65
+
---
66
+
## Set Status
67
+
Sets a status value that can be used for application-specific status tracking. Status values are stored in memory and are not persisted across restarts.
68
+
69
+
_Operation is restricted to super_user roles only_
70
+
71
+
* operation _(required)_ - must always be `set_status`
72
+
* id _(required)_ - the key identifier for the status
73
+
* status _(required)_ - the status value to set (string between 1-512 characters)
74
+
75
+
### Body
76
+
```json
77
+
{
78
+
"operation": "set_status",
79
+
"id": "primary",
80
+
"status": "active"
81
+
}
82
+
```
83
+
84
+
### Response: 200
85
+
```json
86
+
{
87
+
"id": "primary",
88
+
"status": "active",
89
+
"__createdtime__": 1621364589543,
90
+
"__updatedtime__": 1621364589543
91
+
}
92
+
```
93
+
94
+
### Notes
95
+
- The `id` parameter must be one of the allowed status types: 'primary', 'maintenance', or 'availability'
96
+
- If no `id` is specified, it defaults to 'primary'
97
+
- For 'availability' status, only 'Available' or 'Unavailable' values are accepted
98
+
- For other status types, any string value is accepted
99
+
100
+
---
101
+
## Get Status
102
+
Retrieves a status value previously set with the set_status operation.
103
+
104
+
_Operation is restricted to super_user roles only_
105
+
106
+
* operation _(required)_ - must always be `get_status`
107
+
* id _(optional)_ - the key identifier for the status to retrieve (defaults to all statuses if not provided)
108
+
109
+
### Body
110
+
```json
111
+
{
112
+
"operation": "get_status",
113
+
"id": "primary"
114
+
}
115
+
```
116
+
117
+
### Response: 200
118
+
```json
119
+
{
120
+
"id": "primary",
121
+
"status": "active",
122
+
"__createdtime__": 1621364589543,
123
+
"__updatedtime__": 1621364589543
124
+
}
125
+
```
126
+
127
+
If no id parameter is provided, all status values will be returned:
128
+
```json
129
+
[
130
+
{
131
+
"id": "primary",
132
+
"status": "active",
133
+
"__createdtime__": 1621364589543,
134
+
"__updatedtime__": 1621364589543
135
+
},
136
+
{
137
+
"id": "maintenance",
138
+
"status": "scheduled",
139
+
"__createdtime__": 1621364600123,
140
+
"__updatedtime__": 1621364600123
141
+
}
142
+
]
143
+
```
144
+
145
+
---
146
+
## Clear Status
147
+
Removes a status entry by its ID.
148
+
149
+
_Operation is restricted to super_user roles only_
150
+
151
+
* operation _(required)_ - must always be `clear_status`
152
+
* id _(required)_ - the key identifier for the status to remove
0 commit comments