Sign in
Runbooks

Create a new Git runbook

post/{spaceId}/projects/{projectId}/{gitRef}/runbooks/v2

Path parameters

spaceIdstring required
projectIdstring required
gitRefstring required

Request body

ChangeDescriptionstring
DefaultGuidedFailureMode'EnvironmentDefault' | 'Off' | 'On'
Descriptionstring
Environmentsstring[]
EnvironmentScope'All' | 'Specified' | 'FromProjectLifecycles'
ForcePackageDownloadboolean
GitRefstring required
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

GitRefstring required
Idstring required
Namestring required
ProjectIdstring required
Slugstring required

Example response

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

Changes

No recorded changes to this endpoint across all 7 revisions of this API.