Set parser endpoint state¶
Set a parser endpoint online or offline.
PUT https://api.moi.matrixorigin.cn/v5/parser/backends/{backend_id}/endpoints/{endpoint_id}/status
Before you call this API¶
BASE_URL uses the product API prefix https://api.moi.matrixorigin.cn/v5. For a dedicated deployment, use its corresponding product API address.
Configure identity, workspace, and privileges in the same environment.
Request¶
curl --request PUT \
"$BASE_URL/parser/backends/$BACKEND_ID/endpoints/$ENDPOINT_ID/status" \
--header "X-API-Key: $MOI_KEY" \
--header "X-Workspace-ID: $WORKSPACE_ID" \
--header "Content-Type: application/json" \
--data-raw '{"status":"OFFLINE"}'
Parameter |
Location |
Type |
Required |
Description |
|---|---|---|---|---|
|
Header |
string |
Yes |
Workspace ID from the same environment. |
|
Path |
integer |
Yes |
Canonical positive integer ID returned by creation/read for the same Parser kind. |
|
Path |
integer |
Yes |
Canonical positive integer ID returned by creation/read for the same Parser kind. |
|
Body |
string |
No |
Trimmed and uppercased, then matched as ONLINE/OFFLINE. Omitted/null/other values become ONLINE. |
Requires backend update. HTTP 200/data:null; SDK/CLI adapt to success:true. Offline endpoints disappear from current endpoint/backend projections. Retain IDs to restore online state.
Endpoint lists read online items only. Absence after taking offline does not prove deletion. Restore using the retained ENDPOINT_ID.
Successful response¶
{
"code": "OK",
"msg": "OK",
"data": null
}
Field |
Type |
Description |
|---|---|---|
|
string |
HTTP 200; OK on success. |
|
string |
OK on success. |
|
null |
Actual object or null; do not infer from LLM wrappers. |
Error response¶
Errors and result confirmation distinguishes actual inputs, object admission, and business results.