Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 2.87 KB

log-into-the-api-with-powershell.md

File metadata and controls

82 lines (60 loc) · 2.87 KB
Raw

{{{ "title": "Log into the CenturyLink Cloud API with PowerShell", "date": "5-28-2015", "author": "Ted Henley", "attachments": [], "contentIsHTML": false }}}

Overview

CenturyLink Cloud customers can use PowerShell to log into the CenturyLink Cloud API and use the resulting session token for additional API calls

Prerequisites

  • A CenturyLink Cloud Account
  • [An API user has been created](../Accounts & Users/creating-users.md)
  • PowerShell v4+ has been installed on client machine and is being run as administrator

General Notes

  • Recommended to use PowerShell v4+ because PowerShell v3 Invoke-RestMethod has a bug with accept headers
  • Tested on API v1
  • API user and API password need to be entered into the script
  • Script can be used from anywhere - does not have to be on CenturyLink Cloud network

PowerShell V1 Steps

  1. Use the below PowerShell code to retrieve an API session token
#log into API
$URL = 'http://api.ctl.io/REST/Auth/Logon'

#enter in your api user (v1) key and password below
$json = @"
{
  'APIKey': 'insert api user guid', 'Password': 'insert api user password'
} "@

#log into the API via Invoke-RestMethod using JSON payload
$Result = Invoke-RestMethod -URI $URL -Method POST -ContentType application/json -Body $json -SessionVariable session -verbose

#view results. Session variable can be used in future Invoke-RestMethod requests
$Result | FL
  1. You can now use the $session variable for authenticating further API calls. Example:
$RequestURL = 'https://api.ctl.io/REST/Account/GetAccounts/XML'
$content = Invoke-WebRequest -URI $RequestURL -Method POST -ContentType application/xml -WebSession $session -verbose

PowerShell V2 Steps

  1. Use the below PowerShell code to retrieve an API bearer token
#log into API
$URL = 'https://api.tier3.com/v2/authentication/login'

#enter in your api username and password below
$json = @"
{
  'username':'insert api username', 'password':'insert api user password'
} "@

#log into the API via Invoke-RestMethod using JSON payload
$Result = Invoke-RestMethod -URI $URL -Method POST -ContentType application/json -Body $json -verbose

#view results. Session variable can be used in future Invoke-RestMethod requests
$Result | FL

#Create token to be used in all future requests
$BearerToken = "Bearer " + $Result.bearerToken.ToString()
  1. You can now use the $session variable for authenticating further API calls. Example:
$RequestURL = 'https://api.ctl.io/v2/groups/ALIAS/2a5c0b9662cf4fc8bf6180f139facdc0'
$content = Invoke-WebRequest -URI $RequestURL -Headers @{Authorization = $BearerToken} -Method GET -ContentType application/json -Verbose