Skip to content

Bugfixing Template - Statuspage Create Incident #1586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hnrkndrssn merged 3 commits into from
Feb 18, 2025
Merged

Bugfixing Template - Statuspage Create Incident #1586

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
52015a5
bugfix statuspage create incident step template
Sam-Kudo Feb 17, 2025
6660693
updated metadata for this branch
Sam-Kudo Feb 17, 2025
6edecbc
additional metadata update
Sam-Kudo Feb 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions step-templates/statuspageio-create-scheduled-maintenance-incident.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
"Name": "StatusPage.io - Create Scheduled Maintenance Incident",
"Description": "Creates or updates a scheduled maintenance incident on StatusPage.io",
"ActionType": "Octopus.Script",
"Version": 5,
"Version": 6,
"Properties": {
"Octopus.Action.Script.Syntax": "PowerShell",
"Octopus.Action.Script.ScriptSource": "Inline",
"Octopus.Action.RunOnServer": "false",
"Octopus.Action.Script.ScriptBody": "## --------------------------------------------------------------------------------------\r\n## Input\r\n## --------------------------------------------------------------------------------------\r\n$pageId = $OctopusParameters['PageId']\r\n$apiKey = $OctopusParameters['ApiKey']\r\n$incidentName = $OctopusParameters['IncidentName']\r\n$incidentStatus = $OctopusParameters['IncidentStatus']\r\n$incidentMessage = $OctopusParameters['IncidentMessage']\r\n$componentId = $OctopusParameters['ComponentId']\r\n\r\nfunction Validate-Parameter($parameterValue, $parameterName) {\r\n if(!$parameterName -contains \"Key\") {\r\n Write-Host \"${parameterName}: ${parameterValue}\"\r\n }\r\n\r\n if (! $parameterValue) {\r\n throw \"$parameterName cannot be empty, please specify a value\"\r\n }\r\n}\r\n\r\nfunction New-ScheduledIncident\r\n{\r\n [CmdletBinding()]\r\n Param(\r\n [Parameter(Mandatory=$true)]\r\n [string]$PageId,\r\n\r\n [Parameter(Mandatory=$true)]\r\n [string]$ApiKey,\r\n\r\n [Parameter(Mandatory=$true)]\r\n [string]$Name,\r\n\r\n [Parameter(Mandatory=$true)]\r\n [ValidateSet(\"scheduled\", \"in_progress\", \"verifying\", \"completed\")]\r\n [string]$Status,\r\n \r\n [Parameter(Mandatory=$false)]\r\n [string]$Message,\r\n\r\n [Parameter(Mandatory=$false)]\r\n [string]$Componentid\r\n )\r\n\r\n $date = [System.DateTime]::Now.ToString(\"o\")\r\n $url = \"https://api.statuspage.io/v1/pages/$PageId/incidents.json\"\r\n $headers = @{\"Authorization\"=\"OAuth $ApiKey\"}\r\n $body = \"incident[name]=$Name&incident[status]=$Status&incident[scheduled_for]=$date&incident[scheduled_until]=$date\"\r\n\r\n if($Message)\r\n {\r\n $body += \"&incident[message]=$Message\"\r\n }\r\n\r\n if($Componentid)\r\n {\r\n $body += \"&incident[component_ids][]=$Componentid\"\r\n }\r\n\r\n $response = iwr -UseBasicParsing -Uri $url -Headers $headers -Method POST -Body $body\r\n $content = ConvertFrom-Json $response\r\n $content.id\r\n}\r\n\r\nValidate-Parameter $pageId -parameterName 'PageId'\r\nValidate-Parameter $apiKey = -parameterName 'ApiKey'\r\nValidate-Parameter $incidentName = -parameterName 'IncidentName'\r\nValidate-Parameter $incidentStatus -parameterName 'IncidentStatus'\r\n\r\nWrite-Output \"Creating new scheduled maintenance incident `\"$incidentName`\" ...\"\r\nNew-ScheduledIncident -PageId $pageId -ApiKey $apiKey -Name $incidentName -Status $incidentStatus -Message $incidentMessage -ComponentId $componentId\r\n",
"Octopus.Action.Script.ScriptBody": "## --------------------------------------------------------------------------------------\r\n## Input\r\n## --------------------------------------------------------------------------------------\r\n$pageId = $OctopusParameters['PageId']\r\n$apiKey = $OctopusParameters['ApiKey']\r\n$incidentName = $OctopusParameters['IncidentName']\r\n$incidentStatus = $OctopusParameters['IncidentStatus']\r\n$incidentMessage = $OctopusParameters['IncidentMessage']\r\n$componentId = $OctopusParameters['ComponentId']\r\n\r\nfunction Validate-Parameter($parameterValue, $parameterName) {\r\n if(!$parameterName -contains \"Key\") {\r\n Write-Host \"${parameterName}: ${parameterValue}\"\r\n }\r\n\r\n if (! $parameterValue) {\r\n throw \"$parameterName cannot be empty, please specify a value\"\r\n }\r\n}\r\n\r\nfunction New-ScheduledIncident\r\n{\r\n [CmdletBinding()]\r\n Param(\r\n [Parameter(Mandatory=$true)]\r\n [string]$PageId,\r\n\r\n [Parameter(Mandatory=$true)]\r\n [string]$ApiKey,\r\n\r\n [Parameter(Mandatory=$true)]\r\n [string]$Name,\r\n\r\n [Parameter(Mandatory=$true)]\r\n [ValidateSet(\"scheduled\", \"in_progress\", \"verifying\", \"completed\")]\r\n [string]$Status,\r\n \r\n [Parameter(Mandatory=$false)]\r\n [string]$Message,\r\n\r\n [Parameter(Mandatory=$false)]\r\n [string]$Componentid\r\n )\r\n\r\n $date = [System.DateTime]::Now.ToString(\"o\")\r\n $dateTomorrow = [System.DateTime]::Now.AddDays(1).ToString(\"o\")\r\n $url = \"https://api.statuspage.io/v1/pages/$PageId/incidents.json\"\r\n $headers = @{\"Authorization\"=\"OAuth $ApiKey\"}\r\n $body = \"incident[name]=$Name&incident[status]=$Status&incident[scheduled_for]=$date&incident[scheduled_until]=$dateTomorrow\"\r\n\r\n if($Message)\r\n {\r\n $body += \"&incident[message]=$Message\"\r\n }\r\n\r\n if($Componentid)\r\n {\r\n $body += \"&incident[component_ids][]=$Componentid\"\r\n }\r\n\r\n $response = iwr -UseBasicParsing -Uri $url -Headers $headers -Method POST -Body $body\r\n $content = ConvertFrom-Json $response\r\n $content.id\r\n}\r\n\r\nValidate-Parameter $pageId -parameterName 'PageId'\r\nValidate-Parameter $apiKey = -parameterName 'ApiKey'\r\nValidate-Parameter $incidentName = -parameterName 'IncidentName'\r\nValidate-Parameter $incidentStatus -parameterName 'IncidentStatus'\r\n\r\nWrite-Output \"Creating new scheduled maintenance incident `\"$incidentName`\" ...\"\r\nNew-ScheduledIncident -PageId $pageId -ApiKey $apiKey -Name $incidentName -Status $incidentStatus -Message $incidentMessage -ComponentId $componentId\r\n",
"Octopus.Action.Script.ScriptFileName": null,
"Octopus.Action.Package.FeedId": null,
"Octopus.Action.Package.PackageId": null
Expand Down Expand Up @@ -76,11 +76,11 @@
}
}
],
"LastModifiedBy": "nshenoy",
"LastModifiedBy": "Sam-Kudo",
"$Meta": {
"ExportedAt": "2016-10-26T18:49:13.955+00:00",
"OctopusVersion": "3.4.10",
"ExportedAt": "2025-02-17T14:35:00.000+00:00",
"OctopusVersion": "2025.1.8967",
"Type": "ActionTemplate"
},
"Category": "statusPage"
}
}