Set embedding endpoint status through the root API¶
Set the specified embedding endpoint online or offline.
PUT https://api.moi.matrixorigin.cn/v5/embedding/backends/{backend_id}/endpoints/{endpoint_id}/status
Before you call this API¶
Set BASE_URL to the product API prefix https://api.moi.matrixorigin.cn/v5; use the corresponding product API URL for a dedicated deployment.
Configure identity, workspace, and object permissions in the same environment.
Request¶
curl --request PUT \
"$BASE_URL/embedding/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 |
|---|---|---|---|---|
|
Headers |
string |
Yes |
Workspace ID in the same environment. |
|
Path |
integer |
Yes |
Positive ID returned by a preceding read. |
|
Path |
integer |
Yes |
Positive ID returned by a preceding read. |
|
Body |
string |
No |
ONLINE/OFFLINE. Omission, null, or an unrecognized value uses ONLINE. Case is not normalized automatically. |
Requires backend update permission. Path backend_id/endpoint_id selects the target; duplicate IDs in the body do not override the path. The Embedding DAO may treat zero matches as success; reread to confirm.
Successful response¶
{
"code": "OK",
"msg": "OK",
"data": {
"success": true
}
}
HTTP 200。
Field |
Type |
Description |
|---|---|---|
|
string |
OK on success. |
|
string |
OK on success. |
|
object |
Error responses¶
Errors and result confirmation distinguishes the two protocols. Parse omitted fields, SDK zero values, and empty HTTP responses separately. Confirm writes with the corresponding reads.