Delete Grafana tool connection

Delete the Grafana tool connection and associated credentials saved in the current workspace. The interface returns a disconnected status even if there is no current connection.

DELETE https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/tools/grafana/connect

Before you call

Prepare a personal access token and target workspace ID that has access to the target workspace.

The example below uses:

  • $AI_STUDIO_API_KEY: The actual personal access token, passed through the X-API-Key Header.

  • $WORKSPACE_ID: Target workspace ID, passed through X-Workspace-ID Header.

The request body of this interface must be empty.

Request example

curl -X DELETE "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/tools/grafana/connect" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Path parameters

Parameters

Type

Is it required

Description

workspace_id

string

Yes

The current workspace ID.

Successful response

Returns 200 on success. After disconnecting, subsequent Grafana tool calls cannot continue to use the deleted connection credentials.

{
  "code": 0,
  "data": {
    "tool_id": "moi.grafana.tools",
    "status": "disconnected",
    "requires_reconnect": false
  }
}

The response fields are as follows.

Field

Type

Description

code

integer

0 on success.

data.tool_id

string

Grafana built-in tool identifier.

data.status

string

disconnected after disconnection.

data.requires_reconnect

boolean

false after disconnection.

Error response

{
  "code": 2,
  "message": "<错误信息>"
}

Common HTTP errors

HTTP status code

error code

Common causes

Recommended actions

400

2(INVALID_ARGUMENT)

Invalid workspace ID.

Check path parameters.

401

6(UNAUTHENTICATED)

Lack of valid identity credentials.

Check API Key.

403

5(PERMISSION_DENIED)

The current identity does not have permission to manage tool connections.

Check workspace authorization.

503

15(UNAVAILABLE)

Grafana tool connection service or authorization dependency is temporarily unavailable.

Try again later.

Follow-up operations

Query tool tag, confirm that the target no longer appears.

Last updated on