Skip to main content

api.ListJobEvaluationsResponse

items object[]

The actual items

  • Array [
  • deployment_idstring

    DeploymentID is the ID of the deployment this evaluation is associated with, if any

    idstring

    ID is the unique identifier of the evaluation

    job_idstring

    JobID is the unique identifier of the job

    namespacestring

    Namespace is the namespace the evaluation is created in

    priorityinteger

    Priority is the priority of the evaluation. Higher values (e.g. 50) are evaluated before lower values (e.g. 10).

    status object

    Status contains system-managed fields for the evaluation

    created_atstring

    CreatedAt is when the evaluation was created

    messagestring

    Message provides additional context about the current state

    revisioninteger

    Revision is incremented on any change to the evaluation (state changes, status updates, etc.)

    statetypes.EvalStateType (string)

    State is the current processing state of the evaluation

    Possible values: [blocked, pending, complete, failed, canceled]

    updated_atstring

    UpdatedAt is when the evaluation was last updated

    wait_untilstring

    WaitUntil specifies when this evaluation should be processed (for delayed evaluations)

    triggered_bytypes.EvalTrigger (string)

    TriggeredBy is the root cause that triggered the evaluation

    Possible values: [job-create, job-update, job-delete, job-cancel, job-rerun, job-queue, job-timeout, exec-failure, exec-update, exec-timeout, exec-limit, node-update, node-join, node-leave, deployment, deployment-start, deployment-rollback, deployment-resume, periodic, failure, manual]

    typestring

    Type is the type of the job that needs to be evaluated

  • ]
  • next_tokenstring

    Token for next page

    api.ListJobEvaluationsResponse
    {
    "items": [
    {
    "id": "eval-456def789",
    "job_id": "job-abc123xyz",
    "namespace": "production",
    "priority": 50,
    "status": {
    "created_at": "2025-01-15T10:34:00Z",
    "message": "Scheduled on 5 nodes",
    "revision": 3,
    "state": "complete",
    "updated_at": "2025-01-15T10:34:45Z"
    },
    "triggered_by": "job-update",
    "type": "pipeline"
    }
    ],
    "next_token": "string"
    }