API Reference
API ReferenceMCP Guides

Execute command document

post
https://api.corestack.io/v1/runbook//AWS/command/

Execute a command document with all required parameters

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params
string
required

Cloud Account id for which command document need to be executed.

string
required

Region of the document to be executed.

string
required

Name of the document.

string
required

The SSM document version to use in the request.

string

The cryptographic hash value of the document content.

string
enum

The hash algorithm used to calculate the hash value

Allowed:
parameters
object

The required and optional parameters specified in the document being run.

string

The maximum number of managed nodes that are allowed to run the command at the same time.

string

The maximum number of errors allowed without the command failing.

alarm_configuration
object
string

Service Now tracking id

instance_ids
array of strings

The IDs of the managed nodes where the command should run.

instance_ids
targets
array of objects

An array of search criteria that targets managed nodes using a Key,Value combination.

targets
integer

If this time is reached and the command has not already started running, it wont run.

string

User-specified information about the command.

string

The name of the S3 bucket where command execution responses should be stored.

string

The directory structure within the S3 bucket where the responses should be stored.

string

The ARN of the AWS IAM service role to use to publish Amazon SNS notifications for Run Command commands.

notification_config
object
cloud_watch_output_config
object
Responses

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago