List the acting user's in-flight virtual-cypher runs
GET
/api/v1/admin/kg/runs
const url = 'http://localhost:11044/api/v1/admin/kg/runs';const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://localhost:11044/api/v1/admin/kg/runs \ --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”username
string
Optional, and never needed: the call always acts as the signed-in principal. Naming the principal changes nothing; naming anyone else is refused with 403.
Responses
Section titled “Responses”The acting user’s in-flight runs, newest first
Media typeapplication/json
Array<object>
A virtual-cypher run currently executing for the acting user.
object
cypher
required
The Cypher statement being executed.
string
runId
required
The run’s id — also the SSE queryId. Pass it to /kill/{runId}.
string
startedAt
required
Epoch milliseconds at which the run started.
integer format: int64
Example generated
[ { "cypher": "example", "runId": "example", "startedAt": 1 }]No authenticated principal
Media typeapplication/json
A refusal carrying only a human-readable reason.
object
error
required
What went wrong, in the terms the caller can act on.
string
Example generated
{ "error": "example"}username names someone other than the signed-in principal
Media typeapplication/json
A refusal carrying only a human-readable reason.
object
error
required
What went wrong, in the terms the caller can act on.
string
Example generated
{ "error": "example"}