Runbooks

Create a new Database Runbook

post/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/v2

Request

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

Request body

DefaultGuidedFailureMode'EnvironmentDefault' | 'Off' | 'On'
Descriptionstring
Environmentsstring[]
EnvironmentScope'All' | 'Specified' | 'FromProjectLifecycles'
ForcePackageDownloadboolean
MultiTenancyMode'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'
Namestring required
ProjectIdstring required
RunbookTagsstring[]
Slugstring
SpaceIdstring required

Example request

{
  "Environments": [
    "Environments-1",
    "..."
  ],
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Response

Created

Idstring required
Namestring required
ProjectIdstring required
Slugstring required

Example response

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

Changes

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