List Runners

Returns an array of readable Runners in the current Workspace with active internal lifecycle, sorted by creation time descending. Not filtered by registering user. No pagination parameters; data is not wrapped in items. Lists omit connection commands.

GET https://api.moi.matrixorigin.cn/v5/agent-runners

Before you call this API

Set BASE_URL to the product API prefix https://api.moi.matrixorigin.cn/v5. For private deployments, use the corresponding product API URL.

Prepare identity and identifiers.

Request

curl --request GET \
  "$BASE_URL/agent-runners" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID"

Parameter

Location

Type

Required

Description

X-Workspace-ID

Headers

string

Yes

Target Workspace in the same environment; there is no Workspace path segment.

Successful response

{
  "code": "OK",
  "msg": "OK",
  "data": [
    {
      "id": "runner-example",
      "workspace_id": "workspace-example",
      "user_id": "user-example",
      "name": "示例Runner",
      "runner_type": "custom",
      "edge_agent_id": "runner-runner-example",
      "phase": "pending",
      "token_expires_at": "2026-12-12T01:00:00Z",
      "created_at": "2026-11-12T01:00:00Z",
      "updated_at": "2026-11-12T01:00:00Z"
    }
  ]
}

Field

Type

Description

code

string

OK on success.

msg

string

Response information; OK on success.

data

array (objects)

Response objects and omission conditions.

Error responses

Errors and recovery boundaries distinguishes Runner, Edge renewal, and compute observations. They do not share one numeric error table.

Last updated on