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 run, along with its corresponding inputs and the Resource Model instance it will be run against. |
Copied to Clipboard
{
"actionId": "0000",
"instance": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"name": "EC2 Instance",
"description": "EC2 Instance in US-EAST-1 with ID ec2-12345678",
"modelId": "62a1f3d2ebedfc54e6e0065c",
"lastAction": {
"_id": "0000",
"executionId": "62a1f3d2ebedfc54e6e0065c",
"name": "Reboot",
"type": "delete",
"status": "paused"
},
"created": "1952-10-28T18:19:51.636Z",
"createdBy": {
"_id": "Pronghorn",
"username": "consequat anim sit",
"provenance": "ut aute sint dolor sit",
"firstname": "velit do ut"
},
"lastUpdated": "1964-05-31T04:35:57.264Z",
"lastUpdatedBy": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"username": null,
"provenance": "culpa irure occaecat commodo sint",
"firstname": "cillum"
}
},
"instanceName": "EC2 Instance",
"instanceDescription": ""
}
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"
}
]
},
"instanceName": {
"$ref": "resource-instance-common#/definitions/name"
},
"instanceDescription": {
"$ref": "resource-instance-common#/definitions/description"
},
"inputs": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
}
}
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
- |
Copied to Clipboard
{
"message": "A server error occurred while processing this request",
"data": "null",
"metadata": {
"errors": []
}
}
