Introduction

Mimir - An API Gateway and Runtime Platform

Mimir is a batteries included API framework.

At its core, Mimir is a set of tools and an architecture pattern that make it easy to create scalable REST APIs. With Mimir, you can literally build prototypes in minutes and production-ready APIs in days.

Mimir is a lightweight API Gateway, Management Platform, and Runtime that enables you to control who accesses your API, when they access it and how they access it. It also provides the ability to easily expose access to various databases and systems that do not currently have REST APIs. Mimir will also record detailed analytics on how your users are interacting with your API and when things go wrong.

Mimir achieves this by being the glue between some amazing battle-tested open-source technologies - adding a few minimal abstractions and introducing an application architecture that is easier to understand, maintain, and scale.

Why Mimir?

Mímir (Old Norse “The rememberer, the wise one”) or Mim is a figure in Norse mythology renowned for his knowledge and wisdom Wikipedia

What is an API Gateway?

An API Gateway sits in front of your application(s) and/or services and manages the heavy lifting of authorisation, access control and throughput limiting to your services. Ideally, it should mean that you can focus on creating services instead of implementing management infrastructure. For example, if you have written a really awesome web service that provides geolocation data for all the cats in NYC, and you want to make it public, integrating an API gateway is a faster, more secure route than writing your own authorisation middleware.

Key Features

This API Gateway offers powerful, yet lightweight features that allows fine gained control over your API ecosystem.

• Simple API Definitions in YAML, JSON, or XML (with support for Swagger and RAML)
• Drivers supporting: SQL (Oracle, MySQL, Postgres), REST, NoSQL (MongoDB), Cassandra, and more…
• API Lifecycle Management via “GitOps” - Manage APIs using Git and Webhooks
• AAA – OAuth2/SSO + LDAP + RBAC Policies + Service Authorization policies
• Automatic API Documentation
• Generic API Clients in many popular languages (Python, Perl, Javascript, Nodejs)
• Hot-reloading of configuration
• Detailed API Usage logging
• HTTP Streaming for Large requests (Chunked Encoding)
• Async APIs (Websockets) - TBD
• Simple status monitoring
• Developer tools - APIs, CLI, etc.
• Template-driven Request/Response Transforms
• more…

Using Mimir

Mimir is available to all Cisco employees. Please refer to the Mimir Community to Get Started!

Client Libraries

In addition to a REST API, Mimir supports the following client libraries:

Services

As Mimir provides access to several backend services, each service is given its own namespace in the API. The general URI structure of Mimir is /api/mimir/{service}/{request} where:

• service is the namespace of the requested service (e.g. np)
• request is an available method for that service (e.g. companies).

Users can request a list of services and input/output parameters via:

• /api/mimir - Provides a list of all services and requests supported by the system
• /api/mimir/{service} - Provides a list of requests supported by the specific service (e.g. /api/mimir/np)
  

Schema

The following is a truncated sample of the default JSON response:

{
  "meta": {
    "pagination": { "rows": 781, "total": 781, "pages": 1, "page": 1 },
    "attributes": {
      "auth": { "userid": "eforbus" },
      "request": "companies",
      "queryTime": 0.168153,
      "base_url": "https://mimir-prod.cisco.com/api/mimir/np/companies",
      "service": "companies",
      "action": "route",
      "scope": "NP",
      "controller": "Mimir"
    },
    "status": { "status": 1, "state": "PASS", "code": 0 }
  },
  "data": [ ]
}

All API access is over HTTP/S, and accessed from the cisco.com domain. All data is sent and received as JSON.

The base URI for access to Mimir is https://mimir-prod.cisco.com/api/mimir

Blank fields are included as null instead of being omitted.

All timestamps are returned in ISO 8601 format:

YYYY-MM-DDTHH:MM:SS

All response payloads return an object with the following attributes:

Swagger

Download Mimir’s Swagger API Spec and browse the API using the Swagger UI.

Parameters

In this example, :np service is queried using the :groups request and the required cpyKey input parameter is appended to the HTTP query string.

curl -XGET -i "https://mimir-prod.cisco.com/api/mimir/np/groups?cpyKey=123456"

from mimir import Mimir

m = Mimir()
groups = m.np.groups.get(cpyKey=123456)

Many API methods take required and/or optional parameters. For HTTP GET requests, any parameters can be passed as an HTTP query string parameter.

Repeated Parameters

For some input parameters, the option for repeated input is supported. This means that the parameter supports either a single input or an array of inputs if the repeat option is true. You can find out if an input supports Repeat by checking for true vs. false in the Query Parameters table for the service in question.

In these examples, we see how to leverage a repeated parameter using CURL or via any HTTP client and in Python. For HTTP, notice that the field name key value pair must be repeated.

curl -XGET "https://mimir-prod.cisco.com/api/mimir/np/cli?cpyKey=1500&command=show version&command=show cdp neighbors"

from mimir import Mimir

m = Mimir()
cli = m.np.cli.get(cpyKey=1500, command=['show version', 'show cdp neighbors'])

Content Formatting

The API supports multiple content formatting options for most services.

Formatting Input

Output formats can be selected in a number of ways, as shown below:

curl -XGET "https://mimir-prod.cisco.com/api/mimir/np/companies.json"
curl -XGET "https://mimir-prod.cisco.com/api/mimir/np/companies?format=json"
curl -XGET -H "Accept: application/json" "https://mimir-prod.cisco.com/api/mimir/np/companies"
curl -XGET "https://mimir-prod.cisco.com/api/mimir/np/companies.xml"

from mimir import Mimir

m = Mimir()
# get companies in CSV format and write to file
companies = m.np.companies.get(format='csv')
with open('companies.csv', 'wb') as f:
    f.write(companies)

Format HTTP Parameter

Format choices can be controlled via the following parameter to the HTTP GET request:

Format Headers

As an alternative, users may also leverage the Accept HTTP Header to specify output format. The Accept HTTP Header is used to specify media types that are acceptible by the client for response.

The following provides a list of supported Accept header values:

On response, Mimir properly sets the Content-Type HTTP Header to the correct mime type corresponding to the selected format.

HTTP Response Codes and Error Handling

The API pretty much adheres to REST API “standards” when it comes to response codes using the following guidelines

Error Messages

An example JSON error response is shown below

    {
        "reason": "Access to the resource is forbidden",
        "error": "Access Forbidden", 
        "code": 403
    }

API error responses are comprised of 2 parts:

1. The relevant HTTP status code (above)
2. A JSON object with error, which is the error type (e.g. Bad Request), and reason, which provides more detail about the error.

Content Compression

An example of manually setting gzip Accept-Encoding is shown below:

curl -XGET -H "Accept-Encoding: gzip"\
   -i "https://mimir-prod.cisco.com/api/mimir"

HTTP/1.1 200 OK
Content-Length: 8621
X-Mimir-Version: 1.0
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With
Access-Control-Max-Age: 3600
Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Content-Encoding: gzip
X-Mimir-Environment: dev
Vary: Accept-Encoding
Server: Mojolicious (Perl)
Date: Mon, 02 Nov 2015 15:31:26 GMT
Access-Control-Expose-Headers: X-Mimir-Host, X-Mimir-Version, X-Mimir-Environment
Content-Type: application/json;charset=UTF-8
X-Mimir-Host: mimir-dev
Set-Cookie: authorization=loggedIn; expires=Mon, 02 Nov 2015 18:31:26 GMT; domain=cisco.com; path=/
Set-Cookie: ObSSOCookie=GoNrP2KskraDlxYYk1M%2BBqaBvrBG46sFzaMbNy%2BaUTZcwSp7cLnpN9kfrvMGYmFdaKA6%2FQUo%2Baucr4oA5maevdKW0MUtzG%2FW69do52uA0yAkA3UyJCosDjQHVG6uTZxHC8U1KCuun2hMGm4mpxRE5GNslvTInY6Q%2F00hdAZCW7r%2F67MXVDPGINtyD9rsc4rO8KcFNEOLN8Kue8w9NC8QfePpY1%2FIoww6IjKlRHDUyNQBmo0GG5XwNEiuouSmocPc%2FwNGVmR4LNdHIQbFjaS1Ulx7b5p3mMko0QpgzGoEqnLOin5NovOqxLYMln4V%2FIFngmq2K9T7iVjdRJE%2BqzazzD5ZGzRYUO3IpUzVLJinCgY%3D; expires=Mon, 02 Nov 2015 18:31:26 GMT; domain=cisco.com; path=/
Set-Cookie: ObSSOCookietimer=1446478346; domain=cisco.com; path=/
Access-Control-Allow-Origin: *

All Mimir payloads are optionally compressed using gzip encoding to help minimize network transport overhead. HTTP clients can take advantage of this by leveraging the Accept-Encoding HTTP header. If successful the server will set the Vary header to Accept-Encoding and the Content-Encoding header to gzip. Its then left up to the client to decrypt the payload.

Cross Origin Resource Sharing

In order to make requests to the API from other domains, the API implements Cross Origin Resource Sharing (CORS) support.

CORS support is generally used to create AJAX requests outside of the domain that the request originated from. This is necessary to implement projects like control panels utilizing the API. This tells the browser that it can send requests to an outside domain.

The procedure that the browser initiates in order to perform these actions (other than GET requests) begins by sending a “preflight” request. This sets the Origin header and uses the OPTIONS method. The server will reply back with the methods it allows and some of the limits it imposes. The client then sends the actual request if it falls within the allowed constraints.

This process is usually done in the background by the browser, but you can use curl to emulate this process using the example provided. The headers that will be set to show the constraints are:

• Access-Control-Allow-Origin: This is the domain that is sent by the client or browser as the origin of the request. It is set through an Origin header.
• Access-Control-Allow-Methods: This specifies the allowed options for requests from that domain. This will generally be all available methods.
• Access-Control-Expose-Headers: This will contain the headers that will be available to requests from the origin domain.
• Access-Control-Max-Age: This is the length of time that the access is considered valid. After this expires, a new preflight should be sent.
• Access-Control-Allow-Credentials: This will be set to true. It basically allows you to send your OAuth token for authentication.

You should not need to be concerned with the details of these headers, because the browser will typically do all of the work for you.

Here’s a sample request sent from a browser hitting http://example.com:

curl -i -X OPTIONS -H "Origin: http://example.com"\
  "https://mimir-prod.cisco.com/api/mimir"

HTTP/1.1 200 OK
Content-Length: 0
X-Mimir-Host: mimir-dev
X-Mimir-Version: 1.0
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With
Access-Control-Max-Age: 3600
Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
X-Mimir-Environment: dev
Access-Control-Allow-Origin: http://example.com
Server: Mojolicious (Perl)
Access-Control-Expose-Headers: X-Mimir-Host, X-Mimir-Version, X-Mimir-Environment
Date: Mon, 02 Nov 2015 15:25:21 GMT
Content-Type: text/html;charset=UTF-8

The API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. You can read the CORS W3C Recommendation, or this intro from the HTML 5 Security Guide.

Pagination

The API supports pagination for most services.

Pagination Input

Pagination input fields are used as follows. The request below selects page 2 of the result set with 20 rows per page:

curl -XGET "https://mimir-prod.cisco.com/api/mimir/np/companies?page=2&rows=20"

from mimir import Mimir

m = Mimir(paging=True)
companies = m.np.companies.get(page=2, rows=20)

Pagination output can be controlled via the following parameters to the HTTP GET request:

Pagination Output

An example JSON response with pagination meta-data is shown below:

{ 
    "meta": {
        "pagination": {
            "total": 786,
            "rows": 786,
            "pages": 1,
            "page": 1
        },
        ...
    },
    "data": [] 
}

The paginated response always consists of a meta.pagination object with the following attributes:

Pagination HTTP Headers

Pagination outout headers are used as follows. The request below selects page 2 of the result set with 20 rows per page:

curl -i -XGET "https://mimir-prod.cisco.com/api/mimir/np/companies?page=2&rows=20"

X-Total-Count: 784
Link: <https://mimir-prod.cisco.com/api/mimir/np/companies?rows=20&page=1>; rel="prev",
<https://mimir-prod.cisco.com/api/mimir/np/companies?rows=20&page=3>; rel="next",
<https://mimir-prod.cisco.com/api/mimir/np/companies?rows=20&page=40>; rel="last"

In addition to the meta.pagination response, pagination details have been added to HTTP response headers as an additional convenience. These headers are especially handy if an API user decides to leverage an output format like csv or tsv as the pagination data is NOT included in the output response. The pagination headers are as follows:

• X-Total-Count - The count of the total number of rows in the response
• Link - The link header provides one or more, comma-delimited, URL links conforming to the HTTP Header Link Spec.

Sorting

Sorting fields are used as follows. The example below request a sort by the cpyName column in descending order.

curl -XGET "https://mimir-prod.cisco.com/api/mimir/np/companies?sort=cpyName:desc"

Sorting output can be controlled via the following parameters to the HTTP GET request:

Filtering

Filter fields are used as follows. The example below requests only the cpyKey and cpyName fields in the resultset.

curl -XGET "https://mimir-prod.cisco.com/api/mimir/np/companies?fields=cpyKey,cpyName"

Filtering fields can be controlled via the following parameters to the HTTP GET request:

Authentication

The Mimir API provides 2 mechanisms for user authentication:

1. HTTP Basic Authentication - Username and password authenticated via OAuth2 or Active Directory domain via LDAP (for generics).
2. OAuth2 (Preferred) - Secure OAuth2 Access tokens via Cisco Cloud SSO (using Ping Identity as a provider)
3. Single Sign On (SSO) - User SSO session Cookie to integrate with Cisco SSO infrastructure.

HTTP Basic Authentication

For example, if the user agent uses cisco as the username and cisco123 as the password, then the header is formed and used as follows:

curl -XGET -H "Authorization: Basic Y2lzY286Y2lzY28xMjM="\
  "https://mimir-prod.cisco.com/api/mimir/np/companies"

from mimir import Mimir

m = Mimir(username='cisco', password='cisco123')
companies = m.np.companies.get()

The API currently suppports Basic HTTP access authorization and conforms to the standard (http://en.wikipedia.org/wiki/Basic_access_authentication).

When the client makes a request, it must add the Authorization header to the user agent request. The Authorization header is constructed as follows:

1. The Username and Password are combined into a string username:password
2. The resulting string is encoded using Base64
3. The authorization method (e.g. Basic) is put before the string in the header.

OAuth2

This API supports OAuth2 Authentication and will validate tokens provided by any of the following grant types:

• Authorization Code authorizationCode: for apps running on a web server, browser-based and mobile apps used with server-side Applications
• Client Credentials client_credentials: for logging in using client_id/secret only. Typically used for Application or “Machine-to-Machine” API access
• Resource Owner or Password password: for logging in with a username and password. Typically used with trusted Applications, such as those owned by the service itself
• Implicit implicit: used with Mobile Apps or Web Applications (applications that run on the user’s device). Implicit was previously recommended for clients without a secret, but has been superseded by using the Authorization Code grant with no secret.

Authenticating via OAuth requires the following steps:

1. Create a Client
2. Generate a Token
3. Make Authenticated Requests

In order to make requests to this API that leverage OAuth2, each request must contain an Authorization header providing a valid Bearer token (the OAuth2 access token). In order to an OAuth2 access token, you must follow the correct procedure associated with the grant type chosen by your client.

Create a Client

1. External Users should go to https://apiconsole.cisco.com/ and follow the instructions outlined in the API Platform Documentation in order to register an application and generate a new OAuth2 client.
2. Internal Users are recommended to use the Policy Management Tool - PMT to create a new OAuth2 client.

NOTE: If you are required to specify a list of OAuth2 scopes when creating the new client, this API requires the following: openid, email, profile by default. These scopes should also be specified when generating access tokens.

Generate a Token

Resource Owner/Password Grant Type Example

curl -X POST -H "Content-Type: application/x-www-form-urlencoded"\
    -d "grant_type=password" -d "client_id=$(client_id)"\
    -d "client_secret=$(client_secret)" -d "scope=openid+profile+email"\
    -d "username=$(userid)" -d "password=$(password)"\
   "https://cloudsso.cisco.com/as/token.oauth2"

Client Credentials Grant Type Example

curl -X POST -H "Content-Type: application/x-www-form-urlencoded"\
    -d "grant_type=client_credentials" -d "client_id=$(client_id)"\
    -d "client_secret=$(client_secret)" -d "scope=openid+profile+email"\
    "https://cloudsso.cisco.com/as/token.oauth2"

Token Response Example

{
  "access_token": "7mJ1sGjaWcqq2Tm6yI6dX0GEcFrZ",
  "refresh_token": "kNiKgYcVQmYKOpgBzOzatrbei6fiZMGXgG89O4K0z1",
  "token_type": "Bearer",
  "expires_in": 3599
}

Make Authenticated Requests

To authenticate subsequent API requests, you must provide a valid bearer token in an HTTP header:

curl -H "Authorization: Bearer 7mJ1sGjaWcqq2Tm6yI6dX0GEcFrZ" \
    "https://mimir-prod.cisco.com/api/mimir/np/companies"

from mimir import Mimir

m = Mimir(access_token='7mJ1sGjaWcqq2Tm6yI6dX0GEcFrZ')
companies = m.np.companies.get()

Single Sign On (SSO)

The following example shows how to specify the Cookie header for authentication:

curl -XGET -H "Cookie: ObSSOCookie=eyJ1c2VyaWQiOiJlZm9yYnVz..."\ 
  "https://mimir-prod.cisco.com/api/mimir/np/companies"

from mimir import Mimir

m = Mimir(cookies={'ObSSOCookie':"uMGAEDbEy9wIkSDIJZIfKAvymEFaES7rm0EnKq..."})
companies = m.np.companies.get()

SSO or Single-sign-on leverages the Cisco SSO infrastructure to provide authentication via SSO Cookie. This can be used for authenticating user or/and authorizing whether it has sufficient rights to access given service/request.

The SSO Cookie must be provided via HTTP Cookie Header using the ObSSOCookie cookie. For example:

Access Control

Mimir access control is provided on a per service basis and administration/access rights are provided by the service owner.

Accounting

All Mimir API requests are logged for utilization and metrics gathering purposes.

AUTH

The Auth service provides APIs used internally by Mimir for authentication and user lookup.

• Version: v1.0.0
• Owner: mimir-support@cisco.com
• Contact: mimir-support@cisco.com
• Homepage: https://mimir-prod.cisco.com/api

AUTH Login

Mimir Authentication

HTTP Request

curl -XPOST  -H 'userid: userid' -H 'password: password' "https://mimir-prod.cisco.com/api/mimir/auth/login"

from mimir import Mimir

m = Mimir()
login = m.auth.login.post(headers={'userid': 'userid', 'password': 'password'})

POST /api/mimir/auth/login

Header Parameters

Header parameters must be sent via HTTP request headers.

Response

AUTH Me

Mimir Current User

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/auth/me"

from mimir import Mimir

m = Mimir()
me = m.auth.me.get()

GET /api/mimir/auth/me

Response

BCIAPI

APIs for BCIAPI

• Version: vv1
• Owner: mimir-support@cisco.com
• Contact: mimir-support@cisco.com
• Homepage:

BCIAPI History Reset

History reset provides all the resets known for each device as a list of resets.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bciapi/history_reset?earliest=-3d@d&cpyKey=81714"

from mimir import Mimir

m = Mimir()
history_reset = m.bciapi.history_reset.get(earliest='-3d@d', cpyKey=81714)

GET /api/mimir/bciapi/history_reset

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIAPI Latest Reset

This API provides insights into devices that have crashed and the reason for the crash.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bciapi/latest_reset?earliest=-3d@d&cpyKey=81714"

from mimir import Mimir

m = Mimir()
latest_reset = m.bciapi.latest_reset.get(earliest='-3d@d', cpyKey=81714)

GET /api/mimir/bciapi/latest_reset

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIAPI Risk Mitigation Detail

Risk Mitigation Detail provides risk insights for all the devices.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bciapi/risk_mitigation_detail?cpyKey=81714"

from mimir import Mimir

m = Mimir()
risk_mitigation_detail = m.bciapi.risk_mitigation_detail.get(cpyKey=81714)

GET /api/mimir/bciapi/risk_mitigation_detail

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIAPI Risk Mitigation Summary

Risk Mitigation summary provides aggregate risk details per product family. It provides insights into how many devices that are at High, Medium, and Low risk per product family.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bciapi/risk_mitigation_summary?cpyKey=81714"

from mimir import Mimir

m = Mimir()
risk_mitigation_summary = m.bciapi.risk_mitigation_summary.get(cpyKey=81714)

GET /api/mimir/bciapi/risk_mitigation_summary

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIAPI Syslog Daily Statistics

Provides insights into what syslog events have occurred on the network, how often they occurred, what devices were involved, and how severe the events seen were.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bciapi/syslog_daily_statistics?earliest=-3d@d&latest=-2d@d&severity=4&cpyKey=81714"

from mimir import Mimir

m = Mimir()
syslog_daily_statistics = m.bciapi.syslog_daily_statistics.get(earliest='-3d@d', latest='-2d@d', severity='4', cpyKey=81714)

GET /api/mimir/bciapi/syslog_daily_statistics

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIAUDITS

APIs for BCIAUDITS

• Version: vv1
• Owner: mimir-support@cisco.com
• Contact: mimir-support@cisco.com
• Homepage:

BCIAUDITS Bcs Contracts

BCS Contracts provides the list of active BCS Contracts by region and country

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bciaudits/bcs_contracts"

from mimir import Mimir

m = Mimir()
bcs_contracts = m.bciaudits.bcs_contracts.get()

GET /api/mimir/bciaudits/bcs_contracts

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM

APIs for BCIBM

• Version: vv1
• Owner: mimir-support@cisco.com
• Contact: mimir-support@cisco.com
• Homepage:

BCIBM Cbp Peer Avg Bprwithexceptions Count By Category

cbp_peer_avg_bprwithexceptions_count_by_category

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/cbp_peer_avg_bprwithexceptions_count_by_category?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize"

from mimir import Mimir

m = Mimir()
cbp_peer_avg_bprwithexceptions_count_by_category = m.bcibm.cbp_peer_avg_bprwithexceptions_count_by_category.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize')

GET /api/mimir/bcibm/cbp_peer_avg_bprwithexceptions_count_by_category

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Cbp Peer Avg Bprwithexceptions Count By Risk

Peer averageof, unique count of cbp rules ofeach risk level, that have at least one exception for a given customer.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/cbp_peer_avg_bprwithexceptions_count_by_risk?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize&cpyKey=81714"

from mimir import Mimir

m = Mimir()
cbp_peer_avg_bprwithexceptions_count_by_risk = m.bcibm.cbp_peer_avg_bprwithexceptions_count_by_risk.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize', cpyKey=81714)

GET /api/mimir/bcibm/cbp_peer_avg_bprwithexceptions_count_by_risk

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Cbp Peer Avg Monthly Exceptions By Category

Display peer group average of total number of CBP exceptions of specific category, for specific month

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/cbp_peer_avg_monthly_exceptions_by_category"

from mimir import Mimir

m = Mimir()
cbp_peer_avg_monthly_exceptions_by_category = m.bcibm.cbp_peer_avg_monthly_exceptions_by_category.get()

GET /api/mimir/bcibm/cbp_peer_avg_monthly_exceptions_by_category

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Cbp Peer Avg Monthly Exceptions By Risk

Display average total BP exceptions for selected peer group, by risk-level, each month.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/cbp_peer_avg_monthly_exceptions_by_risk"

from mimir import Mimir

m = Mimir()
cbp_peer_avg_monthly_exceptions_by_risk = m.bcibm.cbp_peer_avg_monthly_exceptions_by_risk.get()

GET /api/mimir/bcibm/cbp_peer_avg_monthly_exceptions_by_risk

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Cbp Peer Avg Monthly Exceptions Per Device

cbp_peer_avg_monthly_exceptions_per_device

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/cbp_peer_avg_monthly_exceptions_per_device?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize&cpyKey=81714"

from mimir import Mimir

m = Mimir()
cbp_peer_avg_monthly_exceptions_per_device = m.bcibm.cbp_peer_avg_monthly_exceptions_per_device.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize', cpyKey=81714)

GET /api/mimir/bcibm/cbp_peer_avg_monthly_exceptions_per_device

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Cbp Peer Avg Percentage Inventory Affected

Display peer group average percentage inventory affected by CBP rule

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/cbp_peer_avg_percentage_inventory_affected"

from mimir import Mimir

m = Mimir()
cbp_peer_avg_percentage_inventory_affected = m.bcibm.cbp_peer_avg_percentage_inventory_affected.get()

GET /api/mimir/bcibm/cbp_peer_avg_percentage_inventory_affected

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Cbp Peer Median Total Exceptions By ElementType

Display Peer median value of total CBP exceptions, for each device type/network element type, that is available in the inventory of a given customer.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/cbp_peer_median_total_exceptions_by_elementtype?cpyKey=81714"

from mimir import Mimir

m = Mimir()
cbp_peer_median_total_exceptions_by_elementtype = m.bcibm.cbp_peer_median_total_exceptions_by_elementtype.get(cpyKey=81714)

GET /api/mimir/bcibm/cbp_peer_median_total_exceptions_by_elementType

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Cbp Percentage More Exposed Than Others

Display percentage difference of inventory that does not comply with a CBP than others in the selected peer group

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/cbp_percentage_more_exposed_than_others"

from mimir import Mimir

m = Mimir()
cbp_percentage_more_exposed_than_others = m.bcibm.cbp_percentage_more_exposed_than_others.get()

GET /api/mimir/bcibm/cbp_percentage_more_exposed_than_others

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Chassis Inventory By Pf Peer Avg

Average percentage of chassis inventory that are of aProduct Family for specified peer group of customers

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/chassis_inventory_by_pf_peer_avg?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize"

from mimir import Mimir

m = Mimir()
chassis_inventory_by_pf_peer_avg = m.bcibm.chassis_inventory_by_pf_peer_avg.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize')

GET /api/mimir/bcibm/chassis_inventory_by_pf_peer_avg

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Chassis Inventory By Pid Peer Avg

Peer avg of Percentage Chassis Inventory by Chassis Product ID

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/chassis_inventory_by_pid_peer_avg?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize&cpyKey=81714"

from mimir import Mimir

m = Mimir()
chassis_inventory_by_pid_peer_avg = m.bcibm.chassis_inventory_by_pid_peer_avg.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize', cpyKey=81714)

GET /api/mimir/bcibm/chassis_inventory_by_pid_peer_avg

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Fn Count Peer Comparison

Distribution of distinct Field Notice data exposure count for customers of a specified peer group.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/fn_count_peer_comparison?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize"

from mimir import Mimir

m = Mimir()
fn_count_peer_comparison = m.bcibm.fn_count_peer_comparison.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize')

GET /api/mimir/bcibm/fn_count_peer_comparison

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Fn Count Peer Median

Display median of fieldNoticeId count values

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/fn_count_peer_median?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize&cpyKey=81714"

from mimir import Mimir

m = Mimir()
fn_count_peer_median = m.bcibm.fn_count_peer_median.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize', cpyKey=81714)

GET /api/mimir/bcibm/fn_count_peer_median

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Fn More Exposed Than Others

Deviation of fieldNoticeId from median when compared to other customers

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/fn_more_exposed_than_others?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize"

from mimir import Mimir

m = Mimir()
fn_more_exposed_than_others = m.bcibm.fn_more_exposed_than_others.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize')

GET /api/mimir/bcibm/fn_more_exposed_than_others

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Inventory By Hw By Eox Peer Avg

Peer Avg of Percentage Inventory affected by EoX milestone for HW type

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/inventory_by_hw_by_eox_peer_avg?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize&hardwareType=hardwareType&eoXMilestone=eoXMilestone"

from mimir import Mimir

m = Mimir()
inventory_by_hw_by_eox_peer_avg = m.bcibm.inventory_by_hw_by_eox_peer_avg.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize', hardwareType='hardwareType', eoXMilestone='eoXMilestone')

GET /api/mimir/bcibm/inventory_by_hw_by_eox_peer_avg

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Peer Selection Filters

Displays the peer selection filter values for different customers in benchmarking

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/peer_selection_filters"

from mimir import Mimir

m = Mimir()
peer_selection_filters = m.bcibm.peer_selection_filters.get()

GET /api/mimir/bcibm/peer_selection_filters

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Psirt Count By Eox Peer Median

PSIRT Count Peer Median by EoX milestone

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/psirt_count_by_eox_peer_median?cpyKey=81714&eoXMilestone=eoXMilestone&lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize"

from mimir import Mimir

m = Mimir()
psirt_count_by_eox_peer_median = m.bcibm.psirt_count_by_eox_peer_median.get(cpyKey=81714, eoXMilestone='eoXMilestone', lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize')

GET /api/mimir/bcibm/psirt_count_by_eox_peer_median

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Psirt Count Peer Comparison

Distribution of distinct psirts data exposure count for customers of a specified peer group.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/psirt_count_peer_comparison?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize"

from mimir import Mimir

m = Mimir()
psirt_count_peer_comparison = m.bcibm.psirt_count_peer_comparison.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize')

GET /api/mimir/bcibm/psirt_count_peer_comparison

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Psirt Count Peer Median

Display median of unique psirt count values of the customers of a specified peer group

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/psirt_count_peer_median?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize&cpyKey=81714"

from mimir import Mimir

m = Mimir()
psirt_count_peer_median = m.bcibm.psirt_count_peer_median.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize', cpyKey=81714)

GET /api/mimir/bcibm/psirt_count_peer_median

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Psirt More Exposed Than Others

Deviation of psirts from median when compared to other customers in the selected peer group

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/psirt_more_exposed_than_others?cpyKey=81714&lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize"

from mimir import Mimir

m = Mimir()
psirt_more_exposed_than_others = m.bcibm.psirt_more_exposed_than_others.get(cpyKey=81714, lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize')

GET /api/mimir/bcibm/psirt_more_exposed_than_others

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Swc Conf Peer Avg Of Inventory By Swversion

Distribution of distinct Field Notice data exposure count for customers of a specified peer group.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/swc_conf_peer_avg_of_inventory_by_swversion?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize&swversionnumber=swversionnumber"

from mimir import Mimir

m = Mimir()
swc_conf_peer_avg_of_inventory_by_swversion = m.bcibm.swc_conf_peer_avg_of_inventory_by_swversion.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize', swversionnumber='swversionnumber')

GET /api/mimir/bcibm/swc_conf_peer_avg_of_inventory_by_swversion

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Swc Peer Avg Swage By Month

The peer group median value of average software age for the month.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/swc_peer_avg_swage_by_month?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize"

from mimir import Mimir

m = Mimir()
swc_peer_avg_swage_by_month = m.bcibm.swc_peer_avg_swage_by_month.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize')

GET /api/mimir/bcibm/swc_peer_avg_swage_by_month

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Swc Peer Median Swconformance By Month

peer median value of percentage software conformance

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/swc_peer_median_swconformance_by_month?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize&cpyKey=81714"

from mimir import Mimir

m = Mimir()
swc_peer_median_swconformance_by_month = m.bcibm.swc_peer_median_swconformance_by_month.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize', cpyKey=81714)

GET /api/mimir/bcibm/swc_peer_median_swconformance_by_month

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIBM Swc Peer Median Swdiversity By Month

peer median value of percentage software diversity, for each month of the last 6 months

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/bcibm/swc_peer_median_swdiversity_by_month?lineOfBusiness=lineOfBusiness&naic=naic&naicsubcategory=naicsubcategory&region=region&endcustomersize=endcustomersize&cpyKey=81714"

from mimir import Mimir

m = Mimir()
swc_peer_median_swdiversity_by_month = m.bcibm.swc_peer_median_swdiversity_by_month.get(lineOfBusiness='lineOfBusiness', naic='naic', naicsubcategory='naicsubcategory', region='region', endcustomersize='endcustomersize', cpyKey=81714)

GET /api/mimir/bcibm/swc_peer_median_swdiversity_by_month

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

BCIPVA

APIs for BCIPVA

• Version: vv1
• Owner: mimir-support@cisco.com
• Contact: mimir-support@cisco.com
• Homepage:

CNA

APIs for CNA

• Version: vv1
• Owner: mimir-support@cisco.com
• Contact: mimir-support@cisco.com
• Homepage:

CNA Assessment Status

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cna/assessment_status"

from mimir import Mimir

m = Mimir()
assessment_status = m.cna.assessment_status.get()

GET /api/mimir/cna/assessment_status

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

CNA Audit Details

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cna/audit_details"

from mimir import Mimir

m = Mimir()
audit_details = m.cna.audit_details.get()

GET /api/mimir/cna/audit_details

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD

APIs for COLD

• Version: vv1
• Owner: mimir-support@cisco.com
• Contact: mimir-support@cisco.com
• Homepage:

COLD C3 Pids

C3 PIDs visible in COLD

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/c3_pids"

from mimir import Mimir

m = Mimir()
c3_pids = m.cold.c3_pids.get()

GET /api/mimir/cold/c3_pids

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Field Notices

COLD Field Notices

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/field_notices"

from mimir import Mimir

m = Mimir()
field_notices = m.cold.field_notices.get()

GET /api/mimir/cold/field_notices

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Fn Serial Number

Search Field Notices by Serial Number. Caveat: Much older field notices worked on serial number ranges and won’t be returned by this API.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/fn_serial_number?serialNumber=serialNumber"

from mimir import Mimir

m = Mimir()
fn_serial_number = m.cold.fn_serial_number.get(serialNumber='serialNumber')

GET /api/mimir/cold/fn_serial_number

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Fn Sw Checker

Searches Software Field Notices in COLD based on Software Type and Version.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/fn_sw_checker?swType=IOS-XE&swVersion=15.1(4)M4"

from mimir import Mimir

m = Mimir()
fn_sw_checker = m.cold.fn_sw_checker.get(swType='IOS-XE', swVersion='15.1(4)M4')

GET /api/mimir/cold/fn_sw_checker

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Hmp Data

HMP/MDF data available from Attica

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/hmp_data"

from mimir import Mimir

m = Mimir()
hmp_data = m.cold.hmp_data.get()

GET /api/mimir/cold/hmp_data

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Hw Eox Checker

Hardware EoX Bulletin details

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/hw_eox_checker"

from mimir import Mimir

m = Mimir()
hw_eox_checker = m.cold.hw_eox_checker.get()

GET /api/mimir/cold/hw_eox_checker

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Ib Lookup

All Supportable IB PIDs mapped to Product Rule IC but excluding products not needed from IB (specifically IP Phones).

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/ib_lookup"

from mimir import Mimir

m = Mimir()
ib_lookup = m.cold.ib_lookup.get()

GET /api/mimir/cold/ib_lookup

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Ios Xe Mapping

Translation of software releases for various use-cases such as IOS to IOS-XE, clean-up of invalid XE version, and DNAC Mapping of System to Release

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/ios_xe_mapping"

from mimir import Mimir

m = Mimir()
ios_xe_mapping = m.cold.ios_xe_mapping.get()

GET /api/mimir/cold/ios_xe_mapping

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Pas Latest Package

Returns latest PAS package name

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/pas_latest_package"

from mimir import Mimir

m = Mimir()
pas_latest_package = m.cold.pas_latest_package.get()

GET /api/mimir/cold/pas_latest_package

Response

COLD Pas Package Download

Download latest PAS package in ZIP format

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/pas_package_download"

from mimir import Mimir

m = Mimir()
pas_package_download = m.cold.pas_package_download.get()

GET /api/mimir/cold/pas_package_download

Response

COLD Pce Latest Package

Returns latest PCE package name

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/pce_latest_package"

from mimir import Mimir

m = Mimir()
pce_latest_package = m.cold.pce_latest_package.get()

GET /api/mimir/cold/pce_latest_package

Response

COLD Pce Package Download

Download latest PCE package in ZIP format

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/pce_package_download"

from mimir import Mimir

m = Mimir()
pce_package_download = m.cold.pce_package_download.get()

GET /api/mimir/cold/pce_package_download

Response

COLD Pid Checker

All Supportable PIDs mapped to Product Rule IC.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/pid_checker"

from mimir import Mimir

m = Mimir()
pid_checker = m.cold.pid_checker.get()

GET /api/mimir/cold/pid_checker

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Product Families

COLD Product Family master list

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/product_families"

from mimir import Mimir

m = Mimir()
product_families = m.cold.product_families.get()

GET /api/mimir/cold/product_families

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Product Rule 3rdparty Oids

COLD Active Product Rule SNMP OIDs for just 3rd Party.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/product_rule_3rdparty_oids"

from mimir import Mimir

m = Mimir()
product_rule_3rdparty_oids = m.cold.product_rule_3rdparty_oids.get()

GET /api/mimir/cold/product_rule_3rdparty_oids

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Product Rule 3rdparty Pids

COLD Active 3rd Party Product Rule PIDs

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/product_rule_3rdparty_pids"

from mimir import Mimir

m = Mimir()
product_rule_3rdparty_pids = m.cold.product_rule_3rdparty_pids.get()

GET /api/mimir/cold/product_rule_3rdparty_pids

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Product Rule Na Oids

COLD Product Rule SNMP OIDs that are not FRUable and filtered by PCE.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/product_rule_na_oids"

from mimir import Mimir

m = Mimir()
product_rule_na_oids = m.cold.product_rule_na_oids.get()

GET /api/mimir/cold/product_rule_na_oids

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Product Rule Oids

COLD Active Product Rule SNMP OIDs (not including any 3rd Party).

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/product_rule_oids"

from mimir import Mimir

m = Mimir()
product_rule_oids = m.cold.product_rule_oids.get()

GET /api/mimir/cold/product_rule_oids

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Product Rule Pids

COLD Active Product Rule PIDs (not including any 3rd Party)

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/product_rule_pids"

from mimir import Mimir

m = Mimir()
product_rule_pids = m.cold.product_rule_pids.get()

GET /api/mimir/cold/product_rule_pids

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Product Types

Master list of official Inventory Product Types

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/product_types"

from mimir import Mimir

m = Mimir()
product_types = m.cold.product_types.get()

GET /api/mimir/cold/product_types

Response

COLD Psirt Bulletins

PSIRT bulletins mapped in COLD.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/psirt_bulletins"

from mimir import Mimir

m = Mimir()
psirt_bulletins = m.cold.psirt_bulletins.get()

GET /api/mimir/cold/psirt_bulletins

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Psirt Feature Rules

FIS Features rules that are mapped to PSIRTs.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/psirt_feature_rules"

from mimir import Mimir

m = Mimir()
psirt_feature_rules = m.cold.psirt_feature_rules.get()

GET /api/mimir/cold/psirt_feature_rules

Response

COLD Psirt Mappings

COLD PSIRT Mappings shows a summary of how a given PSIRT is mapped in COLD for automation.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/psirt_mappings"

from mimir import Mimir

m = Mimir()
psirt_mappings = m.cold.psirt_mappings.get()

GET /api/mimir/cold/psirt_mappings

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Psirt Sw Checker

Searches PSIRTs in COLD based on Software Type and Version.

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/psirt_sw_checker?swVersion=15.1(4)M4"

from mimir import Mimir

m = Mimir()
psirt_sw_checker = m.cold.psirt_sw_checker.get(swVersion='15.1(4)M4')

GET /api/mimir/cold/psirt_sw_checker

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Rp Collection

Rule Package Collection Details

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/rp_collection?rulePackage=rulePackage"

from mimir import Mimir

m = Mimir()
rp_collection = m.cold.rp_collection.get(rulePackage='rulePackage')

GET /api/mimir/cold/rp_collection

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Rp Datasets

Rule Package Datasets

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/rp_datasets?rulePackage=rulePackage"

from mimir import Mimir

m = Mimir()
rp_datasets = m.cold.rp_datasets.get(rulePackage='rulePackage')

GET /api/mimir/cold/rp_datasets

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Rp Platform Oids

Rule Package Platform OIDs

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/rp_platform_oids?rulePackage=rulePackage"

from mimir import Mimir

m = Mimir()
rp_platform_oids = m.cold.rp_platform_oids.get(rulePackage='rulePackage')

GET /api/mimir/cold/rp_platform_oids

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Rp Platforms

Rule Package Platforms

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/rp_platforms?rulePackage=rulePackage"

from mimir import Mimir

m = Mimir()
rp_platforms = m.cold.rp_platforms.get(rulePackage='rulePackage')

GET /api/mimir/cold/rp_platforms

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLD Software Type Details

COLD Software Types along with IRT and HMP attributes

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/software_type_details"

from mimir import Mimir

m = Mimir()
software_type_details = m.cold.software_type_details.get()

GET /api/mimir/cold/software_type_details

Response

COLD Software Types

COLD Software Types master list

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/software_types"

from mimir import Mimir

m = Mimir()
software_types = m.cold.software_types.get()

GET /api/mimir/cold/software_types

Response

COLD Unsupported Pids

Known PIDs not supported by Product IC and ib_lookup

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/cold/unsupported_pids"

from mimir import Mimir

m = Mimir()
unsupported_pids = m.cold.unsupported_pids.get()

GET /api/mimir/cold/unsupported_pids

Query Parameters

HTTP Query parameters must be sent in the HTTP URL request and appended to the url after the question mark (?) delimiter.

Response

COLLECTION

APIs for COLLECTION

• Version: vv1
• Owner: mimir-support@cisco.com
• Contact: mimir-support@cisco.com
• Homepage:

COLLECTION Auth

Authentication API

HTTP Request

curl -XGET "https://mimir-prod.cisco.com/api/mimir/collection/auth?userId=mycecid"

from mimir import Mimir

m = Mimir()
auth = m.collection.auth.get(userId='mycecid')