Description

Retrieve a list of queued jobs from the Tines tenant.

Request

HTTP Method: GET

Query Parameter Description
page Optional Retrieve page number from the paginated list (Default is 1).
Path Parameter Description
N/A  
curl -X GET \
  https://<tenant-name>.tines.io/api/v1/admin/queued_jobs \
  -H 'content-type: application/json' \
  -H 'x-user-email: <email-address>' \
  -H 'x-user-token: <api-token>'

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 agent description (AgentReceiveJob type entries only).
agent (Integer) Agent ID (AgentCheckJob type entries only).
events Event ID.
schedule Job scheduled time (AgentRunScheduleJob entries only).
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: 1235,
          type: "AgentRunScheduleJob",
          events: 1,
          retry_count: 5,
          last_retry: 1567399360.056226,
          error_class: ArgumentError
      },
      {
          id: 1236,
          type: "AgentCheckJob",
          agent: 1,
          retry_count: 5,
          last_retry: "",
          error_class: ArgumentError
      },
      {
          id: 1237,
          type: "CredentialRefreshJob",
          agent: 1,
          retry_count: 5,
          last_retry: "",
          error_class: ArgumentError
      }
    ]
    "meta": {
        "current_page": "https://<tenant-name>.tines.io/api/v1/admin/queued_jobs?page=1&per_page=20",
        "previous_page": null,
        "next_page": "https://<tenant-name>.tines.io/api/v1/admin/queued_jobs?page=2&per_page=20",
        "per_page": 20,
        "pages": 0,
        "count": 0
    }
}