---
title: "Creates a new Runbook Run"
method: POST
path: "/{spaceId}/projects/{projectId}/{gitRef}/runbooks/{runbookId}/run/v1"
tags: ["RunbookRuns"]
---

# Creates a new Runbook Run

`POST /{spaceId}/projects/{projectId}/{gitRef}/runbooks/{runbookId}/run/v1`

## Path parameters

- `spaceId` string, required
- `projectId` string, required
- `gitRef` string, required
- `runbookId` string, required

## Request body

- RunGitRunbookCommand
  - `GitRef` string, required
  - `Notes` string
  - `ProjectId` string, required
  - `RunbookId` string, required
  - `Runs` RunGitRunbookRun[], required
    - `ChangeRequestSettings` ChangeRequestSettings[]
      - `Type` 'ServiceNow' | 'JiraServiceManagement'
    - `Comments` string
    - `DebugMode` string
    - `EnvironmentId` string, required
    - `ExcludedMachineIds` string[]
    - `ExcludedTargetTagIds` string[]
    - `FailTargetDiscovery` boolean
    - `ForcePackageDownload` boolean
    - `FormValues` object
    - `Priority` string
    - `QueueTime` string, date-time
    - `QueueTimeExpiry` string, date-time
    - `SkipActions` string[]
    - `SpecificMachineIds` string[]
    - `SpecificTargetTagIds` string[]
    - `TenantId` string
    - `UseGuidedFailure` boolean
  - `SelectedGitResources` SelectedGitResource[]
    - `ActionName` string, required
    - `GitReferenceResource` GitReferenceResource, required
      - `GitCommit` string
      - `GitRef` string
    - `GitResourceReferenceName` string
  - `SelectedPackages` SelectedPackage[]
    - `ActionName` string
    - `PackageReferenceName` string
    - `StepName` string
    - `Version` string
  - `SpaceId` string, required

## Response `200`

The newly-created Runbook run

- RunGitRunbookResponse
  - `Resources` RunbookRunResource[], required
    - `ChangeRequestSettings` ChangeRequestSettings[]
      - `Type` 'ServiceNow' | 'JiraServiceManagement'
    - `Comments` string
    - `Created` string, date-time
    - `DebugMode` string
    - `DeployedBy` string
    - `DeployedById` string
    - `DeployedToMachineIds` string[]
    - `EnvironmentId` string, required
    - `ExcludedMachineIds` string[]
    - `ExcludedTargetTagIds` string[]
    - `ExecutionPlanLogContext` ExecutionPlanLogContext
      - `Steps` StepLogContext[], required
        - `CorrelationId` string, required
        - `Slug` string, required
    - `FailTargetDiscovery` boolean
    - `FailureEncountered` boolean
    - `ForcePackageDownload` boolean
    - `FormValues` object
    - `FrozenRunbookProcessId` string
    - `Id` string
    - `LastModifiedBy` string
    - `LastModifiedOn` string, date-time
    - `Links` object
    - `ManifestVariableSetId` string
    - `Name` string
    - `Priority` string
    - `ProjectId` string
    - `QueueTime` string, date-time
    - `QueueTimeExpiry` string, date-time
    - `RunbookId` string, required
    - `RunbookName` string
    - `RunbookSnapshotId` string, required
    - `SkipActions` string[]
    - `SpaceId` string
    - `SpecificMachineIds` string[]
    - `SpecificTargetTagIds` string[]
    - `TaskId` string
    - `TenantId` string
    - `TentacleRetentionPeriod` RetentionPeriod
      - `QuantityToKeep` integer
      - `ShouldKeepForever` boolean
      - `Strategy` string
      - `Unit` 'Days' | 'Items'
    - `UseGuidedFailure` boolean

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/versions/bc9158facfc7/schema)