Runbooks

Delete an existing Runbook

delete/projects/{projectId}/{gitRef}/runbooks/{id}

Request

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

projectIdstring required

The ID of the project

gitRefstring required

The GitRef containing the resource(s)

idstring required

ID of the Runbook to delete

Request body

ChangeDescriptionstring

The commit message for updating the Git repository

GitRefstring required

The GitRef containing the resource(s)

Idstring required

ID of the Runbook to delete

ProjectIdstring required

The ID of the project

SpaceIdstring required

The ID of the space containing the resource(s).

Example request

{
  "Id": "Runbooks-1",
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Response

Success

Changes

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