Description

Retrieve details of a specific agent.

Request

HTTP Method: GET

Parameter Description
id ID of the desired agent
curl -X GET \
  https://<tenant-name>.tines.io/api/v1/agents/<agent-id> \
  -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 object describing the requested Tines tenant.

Field description

Parameter Description
id Agent ID.
user_id User ID of the agent’s owner.
options JSON Options block of the agent.
name Name of the agent.
schedule Defined run scedule for the agent.
events_count Number of events agent has emitted.
last_check_at ISO 8601 Timestamp respresenting date and time of agent’s last sceduled run.
last_receive_at ISO 8601 Timestamp respresenting date and time of last event received.
last_checked_event_id Last event_id process by the agent.
created_at ISO 8601 Timestamp respresenting creation date and time of agent.
updated_at ISO 8601 Timestamp respresenting last updated date and time of agent.
last_web_request_at ISO 8601 Timestamp respresenting last web request process by the agent.
keep_events_for Defined event retention period in seconds.
last_event_at ISO 8601 Timestamp respresenting date and time the last event was received.
last_error_log_at ISO 8601 Timestamp respresenting date and time of last error thrown by the agent.
disabled Boolean flag indicating whether agent is disabled.
guid Unique identifier of the agent.
story_id ID of story to which the agent belongs.

Sample response

{
    "id": 127,
    "user_id": 1,
    "options": {
        "mode": "deduplicate",
        "lookback": "0",
        "path": "{{.propagation_webhook.password}}",
        "expected_update_period_in_days": "2"
    },
    "name": "Deduplicate",
    "schedule": null,
    "events_count": 0,
    "last_check_at": null,
    "last_receive_at": "2018-05-09T09:42:45.080Z",
    "last_checked_event_id": 87261,
    "created_at": "2018-04-12T16:05:51.638Z",
    "updated_at": "2018-05-09T09:42:45.093Z",
    "last_web_request_at": null,
    "keep_events_for": 31536000,
    "last_event_at": "2018-05-09T09:42:45.058Z",
    "last_error_log_at": null,
    "disabled": false,
    "guid": "d43c450818c2fcba095a0d5d694ebbcc",
    "story_id": 6
}