HTTP - Invoke URL | Octopus Integrations

Octopus.Script exported 2015-08-31 by jmalczak belongs to ‘HTTP’ category.

Invoke HTTP Get request using provided url. Doesn’t throw exception when request fails.

Parameters

When steps based on the template are included in a project’s deployment process, the parameters below can be set.

Url

url

Web request Url

Script body

Steps based on this template will execute the following PowerShell script.

# Running outside octopus
param(
    [string]$url,
    [switch]$whatIf
) 

$ErrorActionPreference = "Stop" 

function Get-Param($Name, [switch]$Required, $Default) {
    $result = $null

    if ($OctopusParameters -ne $null) {
        $result = $OctopusParameters[$Name]
    }

    if ($result -eq $null) {
        $variable = Get-Variable $Name -EA SilentlyContinue   
        if ($variable -ne $null) {
            $result = $variable.Value
        }
    }

    if ($result -eq $null -or $result -eq "") {
        if ($Required) {
            throw "Missing parameter value $Name"
        } else {
            $result = $Default
        }
    }

    return $result
}

& {
    param(
        [string]$url
    ) 

    Write-Host "Invoke Url: $url"

    try {
    
        Invoke-WebRequest -Uri $url -Method Get -UseBasicParsing

    } catch {
        Write-Host "There was a problem invoking Url"    
    }

 } `
 (Get-Param 'url' -Required)

Provided under the Apache License version 2.0.

Report an issue

To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.

{
  "Id": "bb2a8fef-1407-405b-9251-a259c1868bad",
  "Name": "HTTP - Invoke URL",
  "Description": "Invoke HTTP Get request using provided url. Doesn't throw exception when request fails.",
  "Version": 2,
  "ExportedAt": "2015-08-31T12:25:19.923+00:00",
  "ActionType": "Octopus.Script",
  "Author": "jmalczak",
  "Parameters": [
    {
      "Name": "url",
      "Label": "Url",
      "HelpText": "Web request Url",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptBody": "# Running outside octopus\nparam(\n    [string]$url,\n    [switch]$whatIf\n) \n\n$ErrorActionPreference = \"Stop\" \n\nfunction Get-Param($Name, [switch]$Required, $Default) {\n    $result = $null\n\n    if ($OctopusParameters -ne $null) {\n        $result = $OctopusParameters[$Name]\n    }\n\n    if ($result -eq $null) {\n        $variable = Get-Variable $Name -EA SilentlyContinue   \n        if ($variable -ne $null) {\n            $result = $variable.Value\n        }\n    }\n\n    if ($result -eq $null -or $result -eq \"\") {\n        if ($Required) {\n            throw \"Missing parameter value $Name\"\n        } else {\n            $result = $Default\n        }\n    }\n\n    return $result\n}\n\n& {\n    param(\n        [string]$url\n    ) \n\n    Write-Host \"Invoke Url: $url\"\n\n    try {\n    \n        Invoke-WebRequest -Uri $url -Method Get -UseBasicParsing\n\n    } catch {\n        Write-Host \"There was a problem invoking Url\"    \n    }\n\n } `\n (Get-Param 'url' -Required)",
    "Octopus.Action.Script.Syntax": "PowerShell"
  },
  "Category": "HTTP",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/http-invoke-url.json",
  "Website": "/step-templates/bb2a8fef-1407-405b-9251-a259c1868bad",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAIAAAAiOjnJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAB1dJREFUeNrsnc8uO18Yh1ERoRKJ+CYkLNljzwVwAXoBdQHs6V7t6wLaC+AC2GPPykJIxM6fECm/T3qS8zumM9PTabUz+jyr0Z7OTOc8877vnDlTw9/f30MA3WYYsQCxALEAsTgKgFiAWIBYAIgFiAWIBYBYgFiAWACIBYgFiAWAWIBYgFgAiAWIBYgFgFiAWIBYAIgFiAWIBYBYgFiAWACIBYgFiNXM19fX+/s7x25AGB8fHxkZafdTowm2JBfr9TpHfEBIltNGOHDwGyAWIBYgFiAWAGIBYgFiASAWIBYgFgBiAWIBYgEgFiAWIBYAYgFiAWIBIBYgFiAWAGIBYgFiASAWIBYgFkByRnu/ybe3N457hhgeHs7n8+kV6+vr6+npSVZNT0/ncjk6LCt8fHwkECvJD6/V6/V2o46suru7m52d/ffvH12VLWSIglZKxXp8fFSgmpmZoZ8GRKxeFO+fn58Kp1jFVWH3xVK44lgjFgBiAWIBYgEgFiAWIBYAYgFiAWIBIBYgFiAWAGJBahjNyo5eXl7a5aWlpampKTpPHBwc3N/fa2GrQWibarV6dnamhfn5ebVHrB/s7OzY5Uqlsrq62vk6n5+fb25uWq5KvbKxsZHCY6L9Pz09NcuFQiGqmdroaxqxSIW/js5jneJuIAwNk2qjlun8CiYOGaJOD3PyxLcZ6IjV3axaLpft4Y7qD7Ux8WBubi7l5UFMbeDK18u4O4gRS5k03iqhBjbLpBYrTYwxPvIhFvxQ/+XlpaVYPvIhFoQYk8/nFY06kQ+xIESsmJLcRz7EgvBrPZ882Mvrwb9wVXhycqJjp0P88PBgLt90Xm40aC5ULxtowTQ2XFxcuFfsWoOp2c2oo0Htj4+PzbIa2HFIbd2uqlgsmv6u1Wpa59XVlXl9ZWVleXlZH2kZMLRF93JhtUHLktxzoKH343BZFUtH9uDgwFXEGCDOz8/L5bLeDRxNfcT6YblqYOVQJzW3ccWSKK5Y7mf1p7Zraxp3/bJtfX1duxRzXeZuxe5My1AkX6OGPX3kIxUGA9XOzk7AKhf17t7enpr1cpdKpVLAKhfpXigUWg5z+J9X/gVWjHxErB+4KWOugZEp0G2KH25OVDPFm8C1kv24WVZj08Zdm1v5Kq+F7pKsssubm5vqb61K3a/etSeAFhS0KpVKh+NJNvUP+Y1g9T5cZbvGUmfv7u66R01ligKVFUJyKJDYm2j2Nq2yjE1hesWURxaTj9Qr9u6kNtScH0ORmrLZWqhe18rtCL5xQqvSbnfyxQN1YSfyIVaIVc2nvgK+XpQrNiDJj5i7s91Fga1arQZ2SX+aCQXWLdVb29vbzbnJfCPX0ZY5TnVbJ/JRY4VweHgYmlD0ojt7JKYO6zqKTFE5TiHK/VE89/6du+erDjFVkQ23PgVWjHyIFURFTMxxdyN/t4plnwga080B3Tu5C+l5U9lHPsQK6cUUuh7foFu625JcuTLq7OrXjIbMixV1aZbmXQpEjvh5YD4Ry+d6MEY+xCKIDrmXvbZq9Cmw+jjxFbG6g8/QVOfy+UwZ9ZQPsSAkx62srPhMGUWsgaDzS1Qrlk+BFSMfYmUGdzbE74UrO/C7trbWiXyI9XeiUeAyMEGSsjnOzA7qRD7Eygyhg+lRDZJV8W3NaIiRD7EyJtbz83PUu3rLncPTcjQ1NNX6PB7Y3xkNgy5WuzkiZpaV26ZcLke9G5gAGPUsvGcmjSqePOVDrF5QrVZ9njH0mTN4enoa+ssIetG9OVgsFkMv1qTOmkNgoo7P44E+8vWMQXwS2p1ooEBSKBT0ihaKDczrgc4rlUom6ugaPmZulgRS725vb5s7PNfX17VazZ1hIS30bic1XAqfTUWsyFRo8pQ7ZLDUwA1mpk1UeDNqDjUm6hwdHYW2UUEdNdunZchM87OppML/pdnf3w+tUQIprPk/i6qDQ4t0NY6f+aR3lXaT3RJu99nUvhdYWYpYZip6aJ4KYOetx6DyWc3U03beUrNDZkZypVJxB4e0ZsWk5h3QK8qVMkAfCUQ1KaVs27KzA7vtziBt99nUNIjVi/+wqsb6SL/mb/we7tx59ye77AN9cqUrg0k+02C0RRNKu7VRS7L/sDqINdZvYyYZd3GFPmtL2+RHBkgBsQCxALEAEAsQCwYZhhuSs7W1Ze8OpfaXlfsFA6TQgmQDpKRCoMYCxALEAkAsQCxALIBsilWv1znWiNVlxsfHYx7mBMRKuo2RkcnJydvbWw734NCLWzqGx8dHbWtxcXFsbIzjniGS3dLpnVji9fVVOfH9/R23MsTExMTCwkKqxYKMipXL5RhugEEabgDEAkAsQCxALADEAsQCxAJALEAsQCwAxALEAsQCQCxALEAsAMQCxALEAkAsQCxALADEAsSCv0qSR+wBEAsQCxALALEAsQCxABALEAsQCwCxALEAsQAQCxALEAsAsQCxALEAEAsQCxALALEAsQCxABALEAsQCwCxALEAsQAQCxALMsV/AgwA3l1/9Yi7khIAAAAASUVORK5CYII=",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History

Page updated on Monday, August 31, 2015