Runbooks

Get all of the information necessary for creating or editing a Snapshot for a Runbook

get/spaces/{spaceIdentifier}/runbooks/{runbookId}/runbookSnapshotTemplate

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/runbooks/{runbookId}/runbookSnapshotTemplate
  • 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

runbookIdstring required

ID of the Runbook

Query parameters

projectIdstring

Project Id of the project containing the runbook

Response

Confirmation that a new Runbook Snapshot Template has been created, containing the template

Idstring

Gets or sets a unique identifier for this resource.

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.

NextNameIncrementstring
RunbookIdstring
RunbookProcessIdstring

Example response

{
  "Links": {
    "Self": "/api/..."
  }
}

Changes

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