---
title: "Run a resource action"
method: POST
path: "/lifecycle-manager/resources/{modelId}/run-action"
tags: ["Lifecycle Manager"]
---

# Run a resource action

`POST /lifecycle-manager/resources/{modelId}/run-action`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/lifecycle-manager/resources/{modelId}/run-action`
- Auth: none declared

Runs a resource action.

## Path parameters

- `modelId` string, required: A MongoDB ObjectId

## Request body

- object
  - `actionId` string, required: A 4-digit hexadecimal id
  - `instance` union
    - string
    - LifecycleManagerResourceInstanceHttp
      - `_id` unknown, required
      - `name` string, required: The name of the resource instance
      - `description` string, required: Free-form text describing the resource instance
      - `modelId` unknown, required
      - `instanceData` LifecycleManagerResourceInstanceHttpInstanceData, required: The data for the resource instance
      - `lastAction` LifecycleManagerResourceInstanceHttpLastAction, required: The last action that was run on this instance
        - `_id` unknown, required
        - `executionId` unknown, required
        - `name` string, required: The name of the action
        - `type` 'import' | 'create' | 'update' | 'delete', required: The type of the action
        - `status` 'running' | 'error' | 'complete' | 'canceled' | 'paused', required: A single string describing the current activity status of this action
      - `created` unknown, required
      - `createdBy` unknown, required
      - `lastUpdated` unknown, required
      - `lastUpdatedBy` unknown, required
      - `instanceGroups` LifecycleManagerResourceInstanceHttpInstanceGroupsItems[]: The groups that this resource instance is a member of
        - `_id` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId.
        - `name` string: The name of the document
  - `instanceName` string: The name of the resource instance
  - `instanceDescription` string: Free-form text describing the resource instance
  - `inputs` LifecycleManagerResourcesModelIdRunActionPostRequestBodyContentApplicationJsonSchemaInputs

## Response `200`

response

- union
  - LifecycleManagerCommonHttpResponse0: A success response from an API method
    - `message` string, required: A human-readable message summarizing the result of the operation
    - `data` unknown, required
    - `metadata` object, required: Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.
  - LifecycleManagerCommonHttpResponse1: A failure response from an API method
    - `message` string, required: A human-readable message summarizing the result of the operation
    - `data` unknown, required
    - `metadata` LifecycleManagerCommonHttpResponseOneOf1Metadata, required: Any structured, wordy or machine-readable information related to the result of the operation. For error responses, this will always at least contain an 'errors' array, even if it is empty.
      - `errors` unknown[]
        - unknown

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `Lifecycle Manager` added
  - api tag `lifecycleManager` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/lifecycle-manager/resources/:modelId/run-action/post.md)

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)
