---
title: "Run a Gateway service"
method: POST
path: "/gateway_manager/v1/services/run"
tags: ["Gateway Manager"]
---

# Run a Gateway service

`POST /gateway_manager/v1/services/run`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/gateway_manager/v1/services/run`
- Auth: none declared

Runs an IG 5 service given its name and any parameters passed to the service itself.

## Request body

- object
  - `serviceName` string
  - `clusterId` string
  - `params` GatewayManagerV1ServicesRunPostRequestBodyContentApplicationJsonSchemaParams
    - `action` 'apply' | 'destroy': Required for opentofu-plan services
  - `inventory` GatewayManagerV1ServicesRunPostRequestBodyContentApplicationJsonSchemaInventoryItems[]
    - `inventory` string, required
    - `nodeNames` string[]

## Response `200`

The execution result from the gateway including stdout, stderr, and return code

- GatewayManagerRunServiceResponse200
  - `id` string
  - `jsonrpc` string
  - `status` 'completed' | 'error'
  - `result` GatewayManagerV1ServicesRunPostResponsesContentApplicationJsonSchemaResult
    - `return_code` integer: Process exit code (0 = success, >=1 = error)
    - `stdout` string: Raw standard output from the service execution
    - `stderr` string: Standard error from the service execution
    - `stdout_json` union: Parsed JSON from stdout, present only when stdout is valid JSON
      - object
      - unknown[]
        - unknown
      - string
      - number, double
      - boolean

## Other responses

- `500`: Error response from API

## Changes

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

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/gateway_manager/v1/services/run/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)