RunbookRuns

Create a new Runbook Run

post/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/{runbookId}/run/v1

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/{runbookId}/run/v1
  • 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
gitRefstring required
runbookIdstring required

Request body

GitRefstring required
Notesstring
ProjectIdstring required
RunbookIdstring required
SpaceIdstring required

Example request

{
  "ProjectId": "Projects-1",
  "RunbookId": "Runbooks-1",
  "Runs": [
    {
      "EnvironmentId": "Environments-1",
      "TenantId": "Tenants-1"
    }
  ],
  "SpaceId": "Spaces-1"
}

Response

The newly-created Runbook run

Example response

{
  "Resources": [
    {
      "EnvironmentId": "Environments-1",
      "ExecutionPlanLogContext": {
        "Steps": [
          {
            "CorrelationId": "0c5a872485ac4b10857939a92d082e67"
          }
        ]
      },
      "Links": {
        "Self": "/api/..."
      },
      "ProjectId": "Projects-1",
      "SpaceId": "Spaces-1",
      "TaskId": "ServerTasks-1",
      "TenantId": "Tenants-1"
    }
  ]
}

Changes

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