RunbookSnapshots

Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.

Runbook Snapshots will be ordered from most recent to least recent.

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

Request

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

The ID of the project the runbook belongs to.

idstring required

ID of the runbook to get runbook Snapshots for.

Query parameters

searchByNamestring

A partial or complete name to search on. This will perform a "contains" style match against the supplied name or name-fragment

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 30

Response

A paginated list of all of the Runbook Snapshots that belong to the given Runbook.

Idstring

Gets or sets a unique identifier for this resource.

ItemsPerPageinteger
ItemTypestring

The type of item in this list

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.

LastPageNumberinteger
Linksobject

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

NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "Items": [
    {
      "Links": {
        "Self": "/api/..."
      },
      "ProjectId": "Projects-1",
      "RunbookId": "Runbooks-1",
      "SpaceId": "Spaces-1"
    }
  ],
  "ItemsPerPage": 30,
  "ItemType": "RunbookSnapshot",
  "LastPageNumber": 1,
  "Links": {
    "Self": "/api/..."
  },
  "NumberOfPages": 2,
  "TotalResults": 42
}

Changes

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