Sign in

v1

latestOpenAPI 3.0.0CoreStack Inc License2026-07-248001,5071.7 MB
AwsSsm Automation

Execute automation document

Execute a automation document with all required parameters

post/v1/runbook/{tenant_id}/AWS/automation/{document_id}

Request body

cloud_account_idstring required

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

regionstring required

Region of the document to be executed.

document_namestring required

Name of the document.

document_versionstring required

The SSM document version to use in the request.

document_hashstring

The cryptographic hash value of the document content.

document_hash_type'Sha256' | 'Sha1'

The hash algorithm used to calculate the hash value

parametersobject

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

max_concurrencystring

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

max_errorsstring

The maximum number of errors allowed without the command failing.

change_idstring

Service Now tracking id

client_tokenstring

Client auth token.

modestring

Execution mode of the document.

target_parameter_namestring

The name of the parameter used as the target resource for the rate-controlled execution.

target_mapsobject

A key-value mapping of document parameters to target resources.

Example request

{
  "document_hash_type": "Sha256"
}

Response

Created

execution_idstring

Automation Execution Id