Riverbed IQ REST API portal

Overview

The following APIs enable developers to integrate IQ into custom applications or tools that interact with our platform programmatically, enabling seamless integration of our services into your applications. Please read the Terms of Service for more information.

Authorization Information

Calls that require authorization will need to have a bearer token added as an authorization header. Riverbed IQ API services use OAuth 2.0 client credentials grant flow (sometimes called two-legged OAuth). Instructions for how to generate OAuth 2.0 credentials can be found in the IQ User Documentation for the API Access Page

Required Information:

• Client Credentials flow to generate an Access token require the following information. Values should be obtained from the Administration > API Access Page in your Riverbed IQ User Interface.
  • token URI
  • client_id
  • client_secret
  • scope
  • grant_type (client_credentials)

Here is an example using python to retrieve a token:

import requests

# Authorization token params
SCOPE         = '<scope>'
TOKEN_URL     = '<url>'

"""
It is recommended to generate a new API client on the API access page for each
use-case/custom script. Note that the client expires in max 24 months and these
needs to be re-generated.
"""
CLIENT_ID     = '<client Id>'
CLIENT_SECRET = '<client secret>'

# Generate and Authorization token
payload = f'client_id={CLIENT_ID}'
payload += f'&scope={SCOPE}'
payload += '&grant_type=client_credentials'
payload += f'&client_secret={CLIENT_SECRET}'
headers = {
  'Content-Type': 'application/x-www-form-urlencoded'
}
resp = requests.request("POST", TOKEN_URL, headers=headers, data=payload)

print(resp.json())
"""
{
    "token_type": "Bearer",
    "expires_in": 3599,
    "ext_expires_in": 3599,
    "access_token": "..."
}
"""