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
  • Body
  • actionType
  • comments
  • isEnabled
  • isTriggerBySns
  • name
  • parameters
  • projectId
  • schedule
  • tags
  • Returns
  • Sample Request
  • Sample Response
  1. Resources
  2. Actions

CreateAction Method

PreviousAction TypesNextDeleteAction Method

Last updated 2 years ago

Description

Creates a new action.

HTTP Request

POST https://api.skeddly.com/api/Actions/

Body

The body is a JSON structure with the following properties.

actionType

Type of action to create.

Type: string

Valid Values: One of the codes listed in the table.

Required: Yes

comments

User notes for the action.

Type: string

Required: No

isEnabled

True to indicate that the action is executable. False otherwise.

Type: boolean

Required: No

Default: false

isTriggerBySns

True to indicate that the action should be triggerable by an SNS topic.

Type: boolean

Required: No

Default: false

name

Name of the action.

Type: string

Required: Yes

parameters

Additional action parameters specific to the action type.

Required: Yes

projectId

The ID of the project in which to create the action.

Type: string

Required: Recommended for future compatability

Default Value: The account's default project.

schedule

Schedule for the action.

Required: Yes

tags

Tags for the action.

Type: array of string

Required: No

Returns

Sample Request

POST /api/Actions/ HTTP/1.1
Host: api.skeddly.com
Authorization: AccessKey <api key>

{
    "name": "My action",
    "actionType": "amazon-backup-ec2-instances",
    "isEnabled": true,
    "schedule": {
        "scheduleType": "daily",
        "startDate": "2018-02-26",
        "timeOfDay": "12:05:00",
        "endDate": "2018-02-28",
        "timeZoneId": "Eastern Standard Time",
        "parameters": {
            "days": [
                "monday", "friday"
            ]
        }
    },
    "parameters": {    
        "credentialIds": [ "cred-4d1a201c" ],
        "regionNames": [ "us-east-1" ],

        "instanceIdentificationMethod": "all-instances",
        "ConsistencyMethod": "none",
        "Description": "backups-$(DATE)"
    }
}
curl -X POST "https://api.skeddly.com/api/Actions/"
  -H "Authorization: AccessKey <api key>"
  -d name="My action" \
  -d actionType=amazon-backup-ec2-instances \
  -d isEnabled=true \
  -d schedule.scheduleType=daily \
  -d schedule.startDate=2018-02-26 \
  -d schedule.timeOfDay="12:05:00" \
  -d schedule.endDate=2018-02-28 \
  -d schedule.timeZoneId="Eastern Standard Time"\
  -d schedule.parameters.days[]=monday \
  -d schedule.parameters.days[]=friday \
  -d parameters.credentialIds[]=cred-4d1a201c \
  -d parameters.regionNames[]=us-east-1 \
  -d parameters.instanceIdentificationMethod=all-instances \
  -d parameters.ConsistencyMethod=none \
  -d parameters.Description="backups-$(DATE)" \
import skeddly
client = skeddly.Client()
action = client.create_action(
    actionType = "amazon-start-ec2-instances",
    name = "Start Development Instances",
    isEnabled = True,
    schedule = {
        "scheduleType": "daily",
        "startDate": "2019-01-01",
        "timeOfDay": "08:00:00",
        "timeZoneId": "Eastern Standard Time",
        "parameters": {
            "days": [
                "monday",
                "tuesday",
                "wednesday",
                "thursday",
                "friday"
            ]
        }
    },
    parameters = {
        "CredentialIds": [
            "cred-12345678"
        ],
        
        "instanceIdentificationMethod": "all-instances",
        "isStop": True
    }
)

Sample Response

{
    "actionId": "a-00000001",
    "actionType": "amazon-backup-ec2-instances",
    "actionVersionId": "av-00000001",
    "isCurrentVersion": true,
    "isEnabled": true,
    "lastModifiedBy": "u-00000001",
    "lastModifiedDate": "2016-06-09T12:21:00Z",
    "name": "My action",
    "nextExecutionDate": "2016-06-10T12:23:00Z",
    "schedule": {
        "scheduleType": "daily",
        "startDate": "2016-06-10",
        "timeOfDay": "12:23:00",
        "timeZoneId": "Eastern Standard Time",
        "parameters": {
            "days": [
                "monday",
                "friday"
            ]
        }
    },
    "parameters": {    
        "credentialIds": [ "cred-4d1a201c" ],
        "regionNames": [ "us-east-1" ],

        "instanceIdentificationMethod": "all-instances",
        "ConsistencyMethod": "none",
        "Description": "backups-$(DATE)"
    }
}

Type: object.

Type: object

An object.

Action Types
ActionParameters
ActionSchedule
Action