Skeddly API
  • Introduction
  • Overview
    • Making Requests
    • Authentication
    • Clients
    • Errors
      • HTTP Status Codes
      • Error Codes
      • Handling Errors
  • Resources
    • Action Exclusions
      • CreateActionExclusion Method
      • DeleteActionExclusion Method
      • GetActionExclusion Method
      • ListActionExclusions Method
      • ModifyActionExclusion Method
    • Action Executions
      • CancelActionExecution Method
      • GetActionExecution Method
      • GetActionExecutionLog Method
      • ListActionExecutions Method
      • ListUpcomingActionExecutions Method
    • Actions
      • Action Types
      • CreateAction Method
      • DeleteAction Method
      • ExecuteAction Method
      • GetAction Method
      • ListActions Method
      • ModifyAction Method
    • Credentials
      • CreateCredential Method
      • CopyCredential Method
      • DeleteCredential Method
      • GenerateIamPolicy Method
      • GenerateAmazonIamRoleExternalId Method
      • GetCredential Method
      • ListCredentials Method
      • ModifyCredential Method
    • Managed Policies
      • GetManagedPolicy Method
      • ListManagedPolicies Method
    • Managed Services
      • CreateManagedServicesPlan Method
      • CreateManagedServicesSelector Method
      • DeleteManagedServicesPlan Method
      • DeleteManagedServicesSelector Method
      • GetManagedServicesPlan Method
      • GetManagedServicesSelector Method
      • ListManagedServicesPlans Method
      • ListManagedServicesSelectors Method
      • ModifyManagedServicesPlan Method
      • ModifyManagedServicesSelector Method
    • Projects
      • ArchiveProject Method
      • CreateProject Method
      • CreateProjectNotification Method
      • CreateProjectRss Method
      • DeleteProjectNotification Method
      • GetProject Method
      • ListProjects Method
      • ModifyProject Method
      • ModifyProjectAccountNotifications Method
      • ModifyProjectReportEmails Method
    • Reports
      • GetBackupsReport Method
    • Regions
      • GetRegion Method
      • ListRegions Method
    • Time Zones
      • ListTimeZones Method
    • Users
      • AttachManagedPolicy Method
      • CreateUser Method
      • DeleteUser Method
      • DetachManagedPolicy Method
      • GetUser Method
      • ListUsers Method
      • ModifyUser Method
      • ModifyUserPassword Method
      • RemoveUserMfa Method
  • Data Types
    • Action Object
    • ActionExecution Object
    • ActionExecutionResult Object
    • ActionExecutionTrigger Object
    • ActionExclusion Object
    • ActionParameters Object
      • AmazonAddSecurityGroupRuleParameters Object
      • AmazonApplyS3BucketPolicyParameters Object
      • AmazonAssociateElasticIpParameters Object
      • AmazonAttachIamRoleToEc2InstancesParameters Object
      • AmazonBackupEc2InstanceParameters Object
      • AmazonBackupEc2InstancesParameters Object
      • AmazonBackupMySQLServerParameters Object
      • AmazonBackupRoute53HostedZoneParameters Object
      • AmazonBackupRoute53HostedZonesParameters Object
      • AmazonChangeDynamoDbTablesParameters Object
      • AmazonChangeEbsVolumesParameters Object
      • AmazonChangeEc2InstanceTypeParameters Object
      • AmazonChangeEc2InstancesParameters Object
      • AmazonChangeRdsInstanceClassParameters Object
      • AmazonCheckRootAccessKeysParameters Object
      • AmazonCloudFormationStackDriftReportParameters Object
      • AmazonCopyAmiImagesParameters Object
      • AmazonCopyEbsSnapshotsParameters Object
      • AmazonCopyEbsVolumeParameters Object
      • AmazonCopyEc2InstanceParameters Object
      • AmazonCopyRdsSnapshotsParameters Object
      • AmazonCopyS3ObjectsParameters Object
      • AmazonCreateAmiImageParameters Object
      • AmazonCreateAmiImagesParameters Object
      • AmazonCreateCloudFormationStackParameters Object
      • AmazonCreateCloudTrailTrailsParameters Object
      • AmazonCreateDirectoryServiceSnapshotsParameters Object
      • AmazonCreateDynamoDbBackupsParameters Object
      • AmazonCreateEbsSnapshotParameters Object
      • AmazonCreateEbsSnapshotsParameters Object
      • AmazonCreateElastiCacheClusterParameters Object
      • AmazonCreateElastiCacheReadReplicaParameters Object
      • AmazonCreateElastiCacheSnapshotsParameters Object
      • AmazonCreateLightsailInstancesFromSnapshotsParameters Object
      • AmazonCreateLightsailInstanceSnapshotsParameters Object
      • AmazonCreateRdsReadReplicaParameters Object
      • AmazonCreateRdsSnapshotParameters Object
      • AmazonCreateRdsSnapshotsParameters Object
      • AmazonCreateRedshiftSnapshotParameters Object
      • AmazonDeleteEbsSnapshotsParameters Object
      • AmazonDeleteEbsVolumesParameters Object
      • AmazonDeleteRdsSnapshotsParameters Object
      • AmazonDeregisterAmiImagesParameters Object
      • AmazonDisableUnusedIamAccessKeysParameters Object
      • AmazonExportDynamoDbTablesParameters Object
      • AmazonRequestEc2SpotInstancesParameters Object
      • AmazonSendSsmCommandParameters Object
      • AmazonStartEc2InstanceParameters Object
      • AmazonStartEc2InstancesParameters Object
      • AmazonTagEbsSnapshotsParameters Object
      • AmazonUpdateAutoScalingGroupsParameters Object
      • AmazonUpdateEcsServicesParameters Object
      • GoogleResizeManagedInstanceGroupsParameters Object
      • GoogleStartVmInstancesParameters Object
      • GoogleStartCloudSqlInstancesParameters Object
    • ActionSchedule Object
    • AllDatabases Object
    • AutoScalingGroupNameComparison Object
    • AmazonIamRoleExternalId Object
    • AmazonIamAccessKeyParameters Object
    • AmazonIamRoleParameters Object
    • AmazonS3Target Object
    • AmiImageDescriptionComparison Object
    • AmiImageNameComparison Object
    • AmiImageTag Object
    • AmiImageVolumeChanges Object
    • AttachVolumeToInstanceParameters Object
    • AzureCredentialParameters Object
    • BackupsReportItem Object
    • BucketNameComparison Object
    • ChangeDeleteOnTerminate Object
    • ChangeEbsVolumeEncryption Object
    • ChangeEbsVolumeSize Object
    • ChangeEbsVolumeType Object
    • CloudFormationParameter Object
    • CloudFormationStackNameComparison Object
    • CloudTrailCloudWatchLogsProperties Object
    • CreateEbsSnapshot Object
    • CreateLightsailInstancesInstance Object
    • Credential Object
    • DatabaseEndpoint Object
    • DaysDetached Object
    • EbsSnapshotDescriptionComparison Object
    • EbsVolumeIdComparison Object
    • EcsClusterNameComparison Object
    • EcsServiceNameComparison Object
    • ElastiCacheClusterIdComparison Object
    • Error Object
    • FirstInFirstOutDeleteSchemeParameters Object
    • GrandfatherFatherSonDeleteSchemeParameters Object
    • GoogleInstanceNameComparison Object
    • GoogleLabelComparison Object
    • GoogleManagedInstanceGroupNameComparison Object
    • GoogleServiceAccountKeyParameters Object
    • IamUserNameComparison Object
    • InstanceNameComparison Object
    • LightsailInstanceNameComparison Object
    • LightsailInstanceSnapshotNameComparison Object
    • ManagedPolicy Object
    • ManagedServicesGroupIdComparison Object
    • ManagedServicesPlan Object
    • ManagedServicesPlanParameters Object
      • ManagedServicesStartStopPlanParameters Object
    • ManagedServicesPlanSchedule Object
    • ManagedServicesResourceIdComparison Object
    • ManagedServicesResourceTagComparison Object
    • ManagedServicesSelector Object
    • MinimumToKeepPeriodParameters Object
    • NameTagComparison Object
    • Project Object
    • ProjectNotification Object
    • ProjectNotificationAmazonSnsSettings Object
    • ProjectNotificationEmailSettings Object
    • ProjectNotificationSlackSettings Object
    • ProjectNotificationsSettings Object
    • ProjectRssFeed Object
    • RdsInstanceIdComparison Object
    • RdsSnapshotIdComparison Object
    • RdsSourceIdComparison Object
    • Region Object
    • ResourceTagComparison Object
    • RollingInstanceStops Object
    • ScheduleParameters Object
      • DailyScheduleParameters Object
      • HourlyScheduleParameters Object
      • NoneScheduleParameters Object
      • MonthlyScheduleParameters Object
      • WeeklyScheduleParameters Object
    • SendSsmCommandParameter Object
    • SpecificDatabases Object
    • SpotInstanceOptions Object
    • StartEc2InstancesInstance Object
    • TableNameComparison Object
    • Tag Object
    • TimeZone Object
    • UpcomingActionExecution Object
    • User Object
    • UserManagedPolicy
    • WeekAndDay Object
Powered by GitBook
On this page
  • Description
  • HTTP Request
  • URL Parameters
  • id
  • Query Parameters
  • marker
  • Response Headers
  • X-Skeddly-More
  • X-Skeddly-Next-Marker
  • Response Body
  • Examples
  • Sample 1: Getting the first portion of a log
  • Sample 2: Getting the next portion of a log
  1. Resources
  2. Action Executions

GetActionExecutionLog Method

Description

Returns some or all of the activity log from one action execution.

On success, the response of this method will return the activity log in the response body as plain text. It will not be a JSON body. Headers will be included to help retrieve subsequent portions of the activity log.

HTTP Request

GET https://api.skeddly.com/api/ActionExecutions/<id>/Log

URL Parameters

id

The ID of the action execution.

Type: string

Required: Yes

Query Parameters

marker

Omiting this value will retrieve the beginning of the log. Specifying this parameter will retrieve the next portion of the activity log. Markers specified should be those returned from a previous call.

Type: string

Required: No

Response Headers

Some headers will be included to indicate continuation of the log in a later call.

X-Skeddly-More

Indicates whether the log is complete or if there is more to retrieve.

Possible values:

  • none - The log is complete.

  • more - There is more log to retrieve. The next portion can be retrieved immediately.

  • more-later - There is no more log to retrieve now, but the action is still executing, so there will be more later. The next portion can be retrieved later. Delay 1 or 2 minutes then try retrieving the next portion.

X-Skeddly-Next-Marker

Indicates the marker value to include in a subsequent call to retrieve the next portion of the log.

Type: string

Response Body

The response body will contain the activity log in plain text.

Examples

Sample 1: Getting the first portion of a log

Sample Request

This requests omits the marker parameter from the request. This indicates to retrieve the first portion of the log.

GET /api/ActionExecutions/ae-00000001/Log HTTP/1.1
Host: api.skeddly.com
Authorization: AccessKey <api key>
curl "https://api.skeddly.com/api/ActionExecutions/ae-00000001/Log"
  -H "Authorization: AccessKey <api key>"

Sample Response

This response specifies more to show that more log can be downloaded immediately. The next marker is also included to be used to retrieve the next portion.

Content-Type: plain/text
X-Skeddly-More: more
X-Skeddly-Next-Marker: marker1

D:2020-07-13 12:00 Log Starts
D:2020-07-13 12:00 Line 1
D:2020-07-13 12:00 Line 2

Sample 2: Getting the next portion of a log

Sample Request

This requests includes the marker parameter from the previous request. This indicates to retrieve the next portion of the log.

GET /api/ActionExecutions/ae-00000001/Log?marker=marker1 HTTP/1.1
Host: api.skeddly.com
Authorization: AccessKey <api key>
curl "https://api.skeddly.com/api/ActionExecutions/ae-00000001/Log?marker=marker1"
  -H "Authorization: AccessKey <api key>"

Sample Response

This response specifies more to show that there is still more log portions to retrieve. The next marker is included.

Content-Type: plain/text
X-Skeddly-More: more
X-Skeddly-Next-Marker: marker2

D:2020-07-13 12:00 Log Continues
D:2020-07-13 12:00 Line 3
D:2020-07-13 12:00 Line 4

PreviousGetActionExecution MethodNextListActionExecutions Method

Last updated 4 years ago