ListActionExecutions Method

Description

Retrieves the list of action executions.

HTTP Request

GET https://api.skeddly.com/api/ActionExecutions

Query Parameters

include

A comma-separated list of extra extra data to include.

Type: string

Required: No

filter.status

Execution status to limit results.

Type: string

Valid Values:

• all

• errorsOnly

• completedOnly

• runningOnly

Required: No

filter.actionIds

A comma-separated list of action IDs.

Type: string

Required: No

filter.credentialIds

A comma-separated list of credential IDs.

Type: string

Required: No

filter.actionClasses

A comma-separated list of types of actions for which to include executions.

Valid Values:

• standard

• managedInstances

filter.dateComparesTo

Indicator to which the date range references.

Type: string

Valid Values:

• startDate

• endDate

Default: startDate

Required: No

filter.projectIds

A comma-separated list of project IDs to include.

Type: string

Required: Recommended for future compatability

filter.range.inclusiveStart

Start date (inclusive) of the date range, in ISO8601 format.

Type: string

Default: Now - 30 days

Required: No

filter.range.exclusiveEnd

End date (exclusive) of the date range, in ISO8601 format.

Type: string

Default: Now

Required: No

Returns

Array of ActionExecution objects.

Sample Request

HTTP

GET /api/ActionExecutions HTTP/1.1
Host: api.skeddly.com
Authorization: AccessKey <api key>

Bash

curl "https://api.skeddly.com/api/ActionExecutions"
  -H "Authorization: AccessKey <api key>"

Sample Response

[
  {
    "actionExecutionId": "ae-00000001",
    "status": "complete",
    "startDate": "2016-06-01T12:00:00Z",
    "endDate": "2016-06-01T12:03:00Z",
    "result": {
        "code": 0,
        "text": "Execution succeeded"
    },
    "trigger": "schedule",
    "actionId": "a-00000001",
    "actionVersionId": "av-00000001",
    "actionType": "amazon-start-ec2-instance",
    "actionName": "Start My Instances",
    "timeZoneId": "UTC",
    "credentialId": "cred-00000001"
  }
]