コンテンツにスキップ
Yagra

Every analysis schedule, soonest first. Empty in skeleton mode.

GET
/api/v1/analysis/schedules
curl --request GET \
  --url https://example.com/api/v1/analysis/schedules \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Every schedule the caller may see; empty when this deployment has no runner

Media typeapplication/json
Array<object>

A schedule row, as served to the API.

object
at_hour
required
integer format: int32
at_minute
required
integer format: int32
day_of_month
integer | null format: int32
day_of_week
integer | null format: int32
enabled
required
boolean
frequency
required

How often a schedule fires.

string
Allowed values: daily weekly monthly unknown
id
required
string format: uuid
last_run_ms
integer | null format: int64
last_status
One of:
null
next_run_ms
required
integer format: int64
params
required

The launch knobs, the same shape as AnalysisJob.params.

scope_id
string | null format: uuid
scope_kind
required

all | group | node.

string
scope_label
required
string
tool
required

Which diagnostic runs, as an AnalysisTool token.

string
Example
[
  {
    "frequency": "daily",
    "last_status": "queued"
  }
]

401

Section titled “401”

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403”

Role lacks the read permission

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}