Clear EdgeCast CDN Cache
Octopus.Script exported 02/20/2015 by yooakim belongs to 'EdgeCast' category.
This step will clear (purge) the EdgeCast CDN Cache
Parameters
When steps based on the template are included in a project's deployment process, the parameters below can be set.
AccountNumber
CDN Account number, can be found in MCC
ApiToken
API token for accessing the EdgeCast API for the account
MediaPath
A string that indicates the CDN or edge CNAME URL for the asset or the location that will be purged from our edge servers. Make sure to include the proper protocol (i.e., http:// or rtmp://).
MediaType
An integer that indicates the service for which an asset will be purged. It should be replaced with the ID associated with the desired service., default is 3. HTTP Large
Script body
function Clear-EdgeCastCache
{
[CmdletBinding()]
Param
(
# CDN Account number, can be found in MCC
[Parameter(Mandatory=$true)]
$AccountNumber,
# API Token
[Parameter(Mandatory=$true)]
[string]$ApiToken,
# A string that indicates the CDN or edge CNAME URL for the asset or the location that will be purged from our edge servers. Make sure to include the proper protocol (i.e., http:// or rtmp://).
[Parameter(Mandatory=$true)]
[string]
$MediaPath,
#An integer that indicates the service for which an asset will be purged. It should be replaced with the ID associated with the desired service., default is 3. HTTP Large
[ValidateSet(2,3,8,14)]
[int]
$MediaType=3
)
Begin
{
$uri = "https://api.edgecast.com/v2/mcc/customers/$AccountNumber/edge/purge"
$headers = @{
'Authorization' = "tok:" + $ApiToken
'Accept' = 'Application/JSON'
'Content-Type' = 'Application/JSON'
}
$RequestParameters = @{
'MediaPath'=$MediaPath
'MediaType'=$MediaType
}
$body = ConvertTo-Json $RequestParameters
}
Process
{
Write-Verbose "Request body $body"
$request = Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -Body $body -DisableKeepAlive
$request
}
End
{
}
}
Clear-EdgeCastCache -AccountNumber $AccountNumber -ApiToken $ApiToken -MediaPath $MediaPath -MediaType $MediaType -Verbose
To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.
Show JSON{
"Id": "d97ff2d4-250a-4a1a-bd5e-36644893888c",
"Name": "Clear EdgeCast CDN Cache",
"Description": "This step will clear (purge) the EdgeCast CDN Cache",
"Version": 1,
"ExportedAt": "2015-02-20T16:10:46.008+00:00",
"ActionType": "Octopus.Script",
"Author": "yooakim",
"Parameters": [
{
"Name": "AccountNumber",
"Label": null,
"HelpText": "CDN Account number, can be found in MCC",
"DefaultValue": null,
"DisplaySettings": {
"Octopus.ControlType": "SingleLineText"
}
},
{
"Name": "ApiToken",
"Label": null,
"HelpText": "API token for accessing the EdgeCast API for the account",
"DefaultValue": null,
"DisplaySettings": {
"Octopus.ControlType": "Sensitive"
}
},
{
"Name": "MediaPath",
"Label": null,
"HelpText": "A string that indicates the CDN or edge CNAME URL for the asset or the location that will be purged from our edge servers. Make sure to include the proper protocol (i.e., http:// or rtmp://).",
"DefaultValue": null,
"DisplaySettings": {
"Octopus.ControlType": "SingleLineText"
}
},
{
"Name": "MediaType",
"Label": "MediaType",
"HelpText": "An integer that indicates the service for which an asset will be purged. It should be replaced with the ID associated with the desired service., default is 3. HTTP Large",
"DefaultValue": "3",
"DisplaySettings": {
"Octopus.ControlType": "SingleLineText"
}
}
],
"Properties": {
"Octopus.Action.Script.ScriptBody": "function Clear-EdgeCastCache\n{\n [CmdletBinding()]\n Param\n (\n # CDN Account number, can be found in MCC\n [Parameter(Mandatory=$true)]\n $AccountNumber,\n\n # API Token\n [Parameter(Mandatory=$true)]\n [string]$ApiToken,\n\n # A string that indicates the CDN or edge CNAME URL for the asset or the location that will be purged from our edge servers. Make sure to include the proper protocol (i.e., http:// or rtmp://).\n [Parameter(Mandatory=$true)]\n [string]\n $MediaPath,\n\n #An integer that indicates the service for which an asset will be purged. It should be replaced with the ID associated with the desired service., default is 3. HTTP Large\n [ValidateSet(2,3,8,14)]\n [int]\n $MediaType=3\n )\n\n Begin\n {\n $uri = \"https://api.edgecast.com/v2/mcc/customers/$AccountNumber/edge/purge\"\n\n $headers = @{\n 'Authorization' = \"tok:\" + $ApiToken\n 'Accept' = 'Application/JSON'\n 'Content-Type' = 'Application/JSON'\n }\n $RequestParameters = @{\n 'MediaPath'=$MediaPath\n 'MediaType'=$MediaType\n }\n\n $body = ConvertTo-Json $RequestParameters\n\n }\n Process\n {\n Write-Verbose \"Request body $body\"\n \t$request = Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -Body $body -DisableKeepAlive\n $request\n\n }\n End\n {\n }\n}\n\nClear-EdgeCastCache -AccountNumber $AccountNumber -ApiToken $ApiToken -MediaPath $MediaPath -MediaType $MediaType -Verbose\n",
"Octopus.Action.Script.Syntax": "PowerShell"
},
"Category": "EdgeCast",
"HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates/edgecast-cdn-purge.json",
"Website": "/step-templates/d97ff2d4-250a-4a1a-bd5e-36644893888c",
"Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAMAAACahl6sAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAMBQTFRF////rrCzTLtCxcfJ1tfYsLK1z+zNj9SJdMtss7W4U8VIr7G08/T06+vs4uPkuLq96fboTbxDtuKy+fr5Tr1E8/ryvL3BUL9Gqd2l/Pz8/v7+tbe6W8NST8JETbtDZ8Zegc96crht+f35y8zPwMLE/v/+/P788PDx0NLT29zdr7Gz7e7undmX5ebnwue/9/j4S7tB3+DhrrGz9vb2+/z7/f797/juTbtC6Onp///+sri23fLb+/v7/f39ra+y9/z3BkUJcQAAEXlJREFUeNrsXQ1bqszT12DVFXF9QVAWtScwIN+Oxyx7lLvv/63+OwtWxlqCYJ3rYrqvu66TAcPszPzmZWdLpYIKKqigggoqqKCCCiqooIIKKqigggoq6BMF+7U73W5Vd90dTP7B5zcHS3c6lyWsvxOhutxU3WXwrzAxcLeyLUmEYqQoCGF0oLKCMNUlyV6pjcEvZ2I/bdqOjrHCn1wBKpf5twf+//BfMXUcb+6av5aNzdbTafj48NCYUkJIJBHMfqQYH35bRtSR1V+5yvZbm+Lo9SPKnp84tifLvt/k5Mu+7Nk6YRxRHHGDib39ZWIJpjal0dNRSnXPny83Qiuwnvuyg98ER4k3/T28DFRbZyuI6QEmWLflrbv/4uHMx8ZcZn/AeWFr7tcssW7TIeGyJ1SSt+uz/EXQ2MoOpcySMV6ItO3+PB9Th3DFIGyVqPtEb2DqERwuSCK5P8xGQ8JgWBHBktxI/udL3wmXmEK99c+ygULz46kvKTGAK1MSsiL/1Poy54yNMvMI2Gtcch3XY6yA29fnP2HAzKmk/2V+g1JveiHgMFWmLApjhfzA+lr6BNAHzsYPbJhUMEhXX13ZFHcdfl+qbzO68UB1mNazNyNfk5OJq/ObUjnDpbD0MKwv7FzPEg88UHIFZW38pxLlYl5dSef3Hn9zxMt8EXQ9zCVtXyVcacB7U5itzGExd1c6fmCy9q7gUph6lMsP2J7mdPnwNUlq3nysHfBdSMrtlbkS2EPs5OxRVOaDmTp6OarjXsZwD72ROx9Y3+aa2Ql8/rbwNkc+JGZUMGnm7LO6KwhUcpSJy+XhqLmbeTPkxMmJE1NXHti6mpbyp4kMeAXnwwmDEEweZH4dbL0CjcfePgcVtDHYkm2pdCVOKGh89uihtMKQc1tdL8Mkc3/iZW94lTJCeYj6NKQD3EUzVskGi6vL6LpR9R7QCnKWmV7UBiOiL0tXpakD5sXPEgrPwYSQaenKxOM37GeIFEFBSD6Kbg5ee72nXq/3+ngfQz5NiHyIm6naiWKErrttrmTP82Tfn89Vt5sQgz0+7TqzWbV6y6larfY7u9bdxxvYjBOcmQ1eUSWOqwO36UkUqgQhEYqo463cs296t+tUa2NjyEnThhr/btWq/d3rEahXsnLCSwfqMscXM32JYgreF2pS5bAugti/UPu8u95XboEJrQ00en5+Ho34T+3h0BhXd29wTmUiQXo2Vt8H8Uofr7VcRVWBkIkDhTUeJH2fImJsWHWDP/nNMQE7Q2082x1QFwMUSjZuUWWm48jysngBQ+q6LCTGNAPIX1+yUrOGAiYO1G5rhtV5PRgatrhwBvEieyXH0KThQP7pK1Iw9r9YDJuONdROMRHJ5dmoV1vhx2UM2YgMbDkGgbw/V1P/hg0ghO2T77BVtbTR13wAK5pWa/Hq3RosF70c0Nuw7ucfsDz6ng8QiiPOCb+0br8TR8TJSKtVNlF8rSD7Un1fMm3AzkF7Aw+fwwbnRBf6safZeXxwVam1QsxFFOXSeC7w2dt4wyaBh87ko3wiUu3VDO3mXGoPb3vwR1sWmiD7sgCboXcFH65hSufzATKRYpxsbo32zU0CTvrg5wc2iOQioGKy6OZdQ3j4eT4hYn9yKMGi3h4lYOTZGC+4SEBLLsKOawcrJPKF5pQ8lBMR+gxcK2MjCR9M44e1J8Bv4AKkS3zJHEGRMrLDDionJIU8frzaa7KFBaTVO4fnuATOM2f4QKPFGdhYScoIg8wfo6KFZSTkg2nJGDx8QDCLFS8IcHVmLvxQ1ecn+fiCP4U2jyzWKCkjN9pwsQFdJUxX3UtWFiaNKIAWWywEDhLhU2YAS+8iWdRPeBBNMxhpJzz8bYtpicowKpJT2ywHKVQy32ISkbPAjiOxL50gIaOIvOHHnljTGRYx6pZVt+qa9ixy8HUwXIFEFUVKDbOgYyyEi2sd/RU8JtJ9dzkIumt3bhMxJ2+OrGMIBaKx8KOzYNQfW6IPtIfVu3Blp8fAPhRu3SgmEa0d7Lz3KnSbuoiT93ROTbywjNpi92hOSptepVoXqfsfDlSYuioobdbAflCow5/UJIpIk4/rVmtJYA8QjtR9ZxnPInnMnt7exWPHEnykzdfWxGZrK2VpcQB4MVSwrchk4c+5M9MWKBIm/EEnfU3g1EfG7KOnCfr1toCR2SRK2VI1rc1CusoTI7ZQz2PReYPih7hIQsg5HgqecVjrHWHBlsBltrVbYNZldiulT5RRGdtcmHsiWliCLI0UF4lS9qOVJVhYVudz8CgSyRiUBJpGkJQKAkvKIRnuYxG2FdiQORXYBPDIr1WBnxgZtdfP4UpNIBKrAs1gDAIjKU3SNmD2NNTUgaMIYJQnyMat43GwopBBafI0jgtkdGP1Y+1qLO6K2bUQbwEQT5W1ncMfui88mYwEEhGVfExJYN5ARXdW/Y9AQ1qxKyziAWS7XuWhEVMSmiZVZzOBhHapSZAgJu+Kc2ACV+KXzE49LpG2UY0l2s2ddfMc+9ztXZi9SZVNAbSLQ+XyBCpMbGGeVxXYacUzNzOtLfAhfUFMX4t9sq2NexPouEmHUrrMvWGbsyQJVtaJ3Pxa4N6RVOrdxlWdPV9FkIO8jSlJe2TtwrygglL0DTUYYlS45VyKGMFi3zQQeHekM10fjgShRktwhWpd+9P+RAbn2KdKmh6YKUVRFwXvB4qh2hPBgSD8QsTcjeNWVavXngSx3Kyu3RyzMRpykFKaorKSovI+xSzK4E87Feg60leqiOZOnBEWXVUsY3Qq2fM5Lzzr9/uzkKoh3d5yiXQxSmN/VSaQMFEp9HKMSyogEUhmNqMvQOgjoyrO2k8mk6NvbxaNsHebHG1t2ZsMc/C+CDEyqCUicUzizASxCAO+yQDHRE/HCAObDtgI00PJsw7HjNDbOEAZGVYnYaXOYfY3eefFFikkDEbscvliRkYxiQAjScEf82fJXTsLQUJGJtKFAmFw64REkmKN1Ixwxy7yhwkZ+ft/f/5kwIjHzGcznUR4MGLjCxn5+19WjCiXMMKwyqVK8vd3MGJnwEg7zogWZtqvx8hayocRJpFNwtj7Fyyt9s8tLfU3MoLSMgKu9/HXMJLSjyiMEUB1G5FD/E8MtU7Q/4sZ6ZtX8ewMNDp7HvOKPDsm+vlEBIywCHGWUNkZ1kLJQaMK6JdXD+3/BMjcbjwGwcYEYnj76DunzSZ4o0F3Jii5tY3qneC+r5Vj2u12racw/QUwPkU8gg/xiKwIYiX5MQkA71iaoDxYEwVWi/owRvUavNEBxUoKRniEyP+sKQj6vug1EdHCao/OSmuVSp16nbehsf+MAw15PmjJIsQU1XaXIIS2kWzObdA4RTthqDveCbIonbo2+kTasGrymP0BpdgfAyX2MIsiiNnLD8l2d7TGQ4GyWyKMMhsO/8QW4ew+yqLYybMoSxv/DfNaDUeQw6ZJKpMTUUG3zcxW3P7eVeuC5G8/QijITt6nyTON/O/2wgRdoiaXTfWPqDpy+yrINP4RJI4WLwBeU9ZDbVRGYYJXEpitE7u5AldEpVLfiOdM24ZASSpWO86IVuHpNXwooCWjJj7U6GVRbVBcBpvqJE4s0KxY8YLVqG3F19YiXlaIcr9byMan2fXRfauPbHXR2hLufJMpihFomkjbb0b18edc431VwIjBjZaHU267MtnjhxUrV1TowaJtBKZDRdn4E/00DG4tYuYtngBr1zv3UGmFilWqhkAokHBzJ6pYwR6V+HSEpjApuWJ2ayHw7WzRfHLujx1ByVTjyXhwB8hOVQxdQRdg84RvB5nEKgsDXdTowRXtbiyokIy0+jEC3tXiK/BZu4WeLeaWBXXks5ZWgx7q7F1hv0B8U5oszEkSyFdOqpq4i6ly/8GJiOrsoyFHyT5O3aFp6uWHqPPBU060xH70T0thC6qihOuhIuwNYiZ48eZMup2xoKkg7HwAt6Z4KffEeNDyy1+CK27WgokPh2sv545QHjhaD/enelGs2aLVfX3ttSozS9TxaPAyigttjWl3LczRoSfS1E91azkrdbkJBsu5TfCJj0SWpq8JORm1Dava6XT6s7Eh6nNqDznQamIGi9I2MZsYK1SahOqOxFldBFtHCMXkRMr+3SQ8WSc6fjUtjDraoobHkcErjQFEh3YpLYHdCmMSUzrVCXiYC3bq187+PWQ61bvc1hgJ+WACgVZAsOsXbII0oacxmu+hktM5eeWrjtn3uz8lbzIFY/DEazTQ05i+X9YEnxiGUKacoskUIsnlR0CYuMuUAV8wm12KocqdnmA6UBR5pMrTHaM8UazxTQNzvcbdzApfuOsOcAGNQJUIOn7b6N88dtwJF9dIq/HdVgDhFOmivW8AOQ/NfG7SxYXo59aRlqWNkvBhVbjNXBElJTz5EF8wLTm8i1UyTpjnj4cbCXZdgAvhfCxhNtyFYzke+f6R6GUEMlWUBHwIhkxt+ta5+xVGba36dMDU6WLDoxwEbCDRo9xFMCfnb4Shwp7QO4bnz9KTdtuYhRh/Cc3LF49Ggio7ogeDEfjovKK7cjKFNxGF7yJ5DA+tKtC7jC6fxNKAXW/k7eVOId11hrnCpwsZldvhTftm9A0b1ixCxTDoLgwFLhUJcPJufkwfYeVLXmCvq/1FcD15nVknAMnb7lAWp0RtEbA1NJsRDa4DInlfosHWJjCo6CReQVhffd0N2lvUDOP5BC+wX9eqVjZRIO3CTDeSyWiDJt88/eFSwdSPpl4qn+FjGVMizb+zlJOXp85hs+4HIxbuOzaG42rlreAQSIDfs9mbv3cQ823H1xowXhDMwA1n+MJUYoXxQJAzP28j+KRXqdasen04/POsaQb70pi9HdbrVm226733NsH+G+RktKEdjC6OpZSCxkqWCMY6YV86xjCOtblM0PCzaS361drYMtjjAxnGuFbtL54+2iewLWU9qxEDTL/ZaxGb080Shndvp8tBSvu4ues9tXa7XWXX6r3eT45fxNKBTeDZDX0wHRFwyowmk8m9UJI8dsh0oMj0imODPq5pBrgVff6S4TtjHp1FBI3r8rHV2fuj2Q7tG0in1SQv6jq0nHanxRfgUYepqfYVZ+48Qn1foZm/OxeGvGDvapNGlzbzUeUcxmAFPoGm6uaVxnN2+WxAnMc00McmfmCmy78KJ10PChQ5jZrlDcCYNK/Ah2lzedg5jfMKYGfPNVYXhA6wXeMlrxvw+bgY+zlrPB/18WFkRg60hywdpnKuE9y6fF0hJ8+bvKxtPp3TznH2WcPmg76lnMerBVBeQ8hxcxpnavIdKArN3/VCyMaiKCmngY2qzsc7XwMMwdgCmCTt5zDvmblBzod8nYOJVI67vh0+lSJacBCMd76Kq+IyaTphajdbj7JvOgw7PKBrnkwAlh7GaHnqJrNrujbG3CJe9QQPpiiIn0iQ1Wrey7wqrFD5ymcSvETD/JHUzIAVU5UQP+MAN0tXp0efKGDxsdS80H69zB04SQkKET9zBEnX5kcTYOSsLnDDe1/CfHL0FYbFn9R52VFQeCBVs5vO1EDLBOVgQZcbP3gQ1FrW4dAzRLHjqYnXxX4qO3wTJmej9KNkrsPd7myBUSfZPGAmT4pwWBXyfpiN0B974RlOiGAi+Y2zzGfQ8CWKwumbiHqNX3K6WJetEH7YHgwz1W1/+9WY2cle9eEksuhkMeT4y9IvoqakwxGBMG2IKlh3vKbb6AZHL9oMug137jk6EwU/xoZ9nkir33YE337qSVDXR9GYWUTgDEebzwL24eQ9z7ZhehX7FQ4PeUNEsrf70i+kgetLDuzWCJc+5lveUVgJYj/CLnH0EP4GYV3y1W7p19LG9T2dn09zoIf3H6O+LjgukenRbz9tE3RflXktCxwMDneVhWdsIl7WktV96V+iwXoeagdTD4+fVemr60HpH6Vg312uGS27+2BSKqigggoqqKCCCiqooIIKKqigggoqqKCM6H8CDACqMNnmHuC6DQAAAABJRU5ErkJggg==",
"$Meta": {
"Type": "ActionTemplate"
}
}Provided under the Apache License version 2.0.