Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Ops Manager Administration API Resources
/
Agents

Retrieve All Agent Versions

On this page

  • Required Roles
  • Request
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body

Required Roles

You can successfully call this endpoint with any of the following assigned roles:

Request

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /softwareComponents/versions/

Request Path Parameters

This endpoint doesn't use HTTP request path parameters.

Request Query Parameters

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

Flag that indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

Name
Description
status
HTTP response code
envelope
Expected response body
false

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

Name
Type
Description
automationVersion
string
Latest version of the MongoDB Agent.
automationMinimumVersion
string
Minimum supported version of the MongoDB Agent.
biConnectorVersion
string
Latest version of the BI Connector.
biConnectorMinimumVersion
string
Minimum supported version of the BI Connector.
mongoDbToolsVersion
string
Latest version of MongoDB Tools installed.
links
array of objects

One or more links to sub-resources and/or related resources. All links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.

Example Request

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --request GET "http://{opsManagerHost}:{port}/api/public/v1.0/softwareComponents/versions?pretty=true"

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

1{
2  "automationVersion": "10.14.0.6304",
3  "automationMinimumVersion": "10.2.17.5964",
4  "biConnectorVersion": "2.3.4",
5  "biConnectorMinimumVersion": "2.3.1",
6  "mongoDbToolsVersion": "100.0.1",
7  "links": [
8    {
9      "href": "http://{opsManagerHost}:{port}/api/public/v1.0/agents/current",
10      "rel": "self"
11    }
12  ]
13}

Back

Get Agents by Type for One Project

Next

Retrieve All Agent Versions for One Project