Summary
Runs a resource action
Description
Runs a resource action
Route
POST /lifecycle-manager/resources/:modelId/run-action
Roles
admin
apiwrite
designer
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| modelId |
string |
yes |
The ID of the Resource Model to run an action on |
| options |
object |
yes |
Designates the action to initiate and which instance and inputs to use when initiating it. |
Copied to Clipboard
{
"actionId": "0a2f",
"instance": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"name": "EC2 Instance",
"description": "",
"modelId": "62a1f3d2ebedfc54e6e0065c",
"instanceData": null,
"lastAction": {
"_id": "0a2f",
"executionId": "62a1f3d2ebedfc54e6e0065c",
"name": "Suspend",
"type": "delete",
"status": "complete"
},
"created": "1964-09-27T04:18:27.818Z",
"createdBy": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"username": null,
"provenance": "sint laborum proident deserunt",
"firstname": "sit labore magna"
},
"lastUpdated": "1969-07-25T03:29:47.759Z",
"lastUpdatedBy": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"username": null,
"provenance": "enim veniam culpa",
"firstname": "tempor voluptate exercitation"
}
},
"newInstanceName": "EC2 Instance",
"newInstanceDescription": "EC2 Instance in US-EAST-1 with ID ec2-12345678",
"inputs": null
}
Copied to Clipboard
{
"title": "options",
"type": "object",
"required": [
"actionId"
],
"additionalProperties": false,
"properties": {
"actionId": {
"$ref": "resource-model-common#/definitions/action-identifier"
},
"instance": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "resource-instance-http"
}
]
},
"newInstanceName": {
"$ref": "resource-instance-common#/definitions/name"
},
"newInstanceDescription": {
"$ref": "resource-instance-common#/definitions/description"
},
"inputs": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
}
}
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
- |
Copied to Clipboard
{
"message": "Successfully created the requested item",
"data": "null"
}
