List queued jobs

Description

Fetch the current queue of jobs from the Tines tenant. This API endpoint is specifically for dedicated tenants. It provides a snapshot of the job queue as it exists at the moment the request is sent.

Request

HTTP Method: GET

Query Parameter Description
page Optional Retrieve page number from the paginated list. Defaults to 1.
per_page Optional Set the number of results returned per page. Defaults to 20.
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/admin/queued_jobs \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON Array describing queued jobs in the Tines tenant.

Field description

Parameter Description
id Job ID.
type Job type.
agent (Hash) Contains action description (AgentReceiveJob type entries only).
events Event ID.
started_at Job starting time.

Sample response

{
    "admin/queued_jobs":
    [
      {
          id: 1234,
          type: "AgentReceiveJob",
          agent: {
            id: 1,
            name: "Agent 01",
          },
          events: 1,
          retry_count: 5,
          last_retry: 1567399360.056226,
          error_class: ArgumentError
      },
      {
          id: 1237,
          type: "CredentialRefreshJob",
          agent: 1,
          retry_count: 5,
          last_retry: "",
          error_class: ArgumentError
      }
    ]
    "meta": {
        "current_page": "https://<<META.tenant.domain>>/api/v1/admin/queued_jobs?page=1&per_page=20",
        "previous_page": null,
        "next_page": "https://<<META.tenant.domain>>/api/v1/admin/queued_jobs?page=2&per_page=20",
        "next_page_number": 2,
        "per_page": 20,
        "pages": 0,
        "count": 0
    }
}
Was this helpful?