---
title: "POST /api/github/v1/compute-node/{compute_node_id}/initiate"
method: POST
path: "/api/github/v1/compute-node/{compute_node_id}/initiate"
---

# POST /api/github/v1/compute-node/{compute_node_id}/initiate

`POST /api/github/v1/compute-node/{compute_node_id}/initiate`

## Request

- The document declares no server URL.
- Auth: none declared

## Path parameters

- `compute_node_id` string, required

## Request body

- WorkManifestInitiate
  - `run_id` string, required
  - `sha` string, required

## Response `200`

- union
  - WorkManifestPlan
    - `api_base_url` string, required
    - `base_dirspaces` WorkManifestDir[], required
      - `path` string, required
      - `rank` integer, required: Starts at 0, relative dependency order to perform operation on dir.
      - `stack_name` string, required
      - `variables` object
      - `workflow` integer
      - `workspace` string, required
    - `base_ref` string, required
    - `capabilities` string[], required
    - `changed_dirspaces` WorkManifestDir[], required
      - `path` string, required
      - `rank` integer, required: Starts at 0, relative dependency order to perform operation on dir.
      - `stack_name` string, required
      - `variables` object
      - `workflow` integer
      - `workspace` string, required
    - `config` unknown, required
    - `dirspaces` WorkManifestDir[], required
      - `path` string, required
      - `rank` integer, required: Starts at 0, relative dependency order to perform operation on dir.
      - `stack_name` string, required
      - `variables` object
      - `workflow` integer
      - `workspace` string, required
    - `id` string
    - `installation_id` string, required
    - `protocol_version` integer
    - `result_version` integer, required
    - `run_kind` string, required
    - `run_kind_data` RunKindDataPullRequest
      - `id` string, required
    - `token` string, required
    - `type` string, required
  - WorkManifestApply
    - `api_base_url` string, required
    - `base_ref` string, required
    - `capabilities` string[], required
    - `changed_dirspaces` WorkManifestDir[], required
      - `path` string, required
      - `rank` integer, required: Starts at 0, relative dependency order to perform operation on dir.
      - `stack_name` string, required
      - `variables` object
      - `workflow` integer
      - `workspace` string, required
    - `config` unknown, required
    - `id` string
    - `installation_id` string, required
    - `protocol_version` integer
    - `result_version` integer, required
    - `run_kind` string, required
    - `run_kind_data` RunKindDataPullRequest
      - `id` string, required
    - `token` string, required
    - `type` string, required
  - WorkManifestIndex
    - `base_ref` string, required
    - `config` unknown, required
    - `dirs` string[], required
    - `id` string
    - `token` string, required
    - `type` string, required
  - WorkManifestUnsafeApply
    - `base_ref` string, required
    - `changed_dirspaces` WorkManifestDir[], required
      - `path` string, required
      - `rank` integer, required: Starts at 0, relative dependency order to perform operation on dir.
      - `stack_name` string, required
      - `variables` object
      - `workflow` integer
      - `workspace` string, required
    - `config` unknown, required
    - `id` string
    - `run_kind` string, required
    - `token` string, required
    - `type` string, required
  - WorkManifestBuildConfig
    - `base_ref` string, required
    - `config` unknown, required
    - `id` string
    - `token` string, required
    - `type` string, required
  - WorkManifestDone
    - `type` string, required
  - WorkManifestBuildTree
    - `base_ref` string, required
    - `config` unknown, required
    - `id` string
    - `token` string, required
    - `type` string, required

## Other responses

- `403`

## Changes

- **2026-09-16** `57f5f7ef3053`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/terrateamio/apis/terrateam-terrat-api/changes/api/github/v1/compute-node/:compute_node_id/initiate/post.md)

---

[API](https://skmtc.dev/terrateamio/apis/terrateam-terrat-api.md) - [All operations](https://skmtc.dev/terrateamio/apis/terrateam-terrat-api/llms.txt) - [OpenAPI document](https://skmtc.dev/terrateamio/apis/terrateam-terrat-api/revisions/e690d2cffc49?raw)