Runbooks

Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).

get/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}/runbookRunTemplate

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}/runbookRunTemplate
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

projectIdstring required

ID of the project the runbook belongs to

idstring required

ID of the Runbook to get a Runbook Run Template for

Response

The requested Runbook Template

Idstring

Gets or sets a unique identifier for this resource.

IsGitResourceModifiedboolean
IsLibraryVariableSetModifiedboolean
IsRunbookProcessModifiedboolean
IsVariableSetModifiedboolean
LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Example response

{
  "Links": {
    "Self": "/api/..."
  },
  "PromoteTo": [
    {
      "Id": "Environments-1"
    }
  ],
  "TenantPromotions": [
    {
      "Links": {
        "Self": "/api/..."
      },
      "PromoteTo": [
        {
          "Id": "Environments-1"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 13 revisions of this API.