---
title: "Get a Runbook Run Template for a Runbook Snapshot"
method: GET
path: "/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/template"
tags: ["RunbookSnapshots"]
---

# Get a Runbook Run Template for a Runbook Snapshot

`GET /projects/{projectId}/runbookSnapshots/{id}/runbookRuns/template`

## Request

- Base URL: `https://demo.octopus.app/api`
- URL: `https://demo.octopus.app/api/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/template`
- Auth: one of:
  - API key in header `X-Octopus-ApiKey`
  - API key in query parameter `ApiKey`
  - API key in header `X-NuGet-ApiKey`

Gets all of the information necessary for creating or editing a run for this snapshot.

## Path parameters

- `projectId` string, required
- `id` string, required

## Response `200`

The requested Runbook Run Template

- RunbookRunTemplateResource
  - `Id` string: Gets or sets a unique identifier for this resource.
  - `IsGitResourceModified` boolean
  - `IsLibraryVariableSetModified` boolean
  - `IsRunbookProcessModified` boolean
  - `IsVariableSetModified` boolean
  - `LastModifiedBy` string: Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time: Gets or sets the date/time that this resource was last modified.
  - `Links` object: Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  - `PromoteTo` DeploymentPromotionTarget[]
    - `Id` string
    - `Links` object
    - `Name` string
  - `TenantPromotions` DeploymentPromotionTenant[]
    - `Id` string: Gets or sets a unique identifier for this resource.
    - `LastModifiedBy` string: Gets or sets the username of the user who last modified this resource.
    - `LastModifiedOn` string, date-time: Gets or sets the date/time that this resource was last modified.
    - `Links` object: Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
    - `Name` string
    - `PromoteTo` DeploymentPromotionTarget[]
      - `Id` string
      - `Links` object
      - `Name` string

## 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.dev/octopus/apis/octopus-server-api.md) - [All operations](https://skmtc.dev/octopus/apis/octopus-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octopus/apis/octopus-server-api/revisions/fe937c07da34?raw)