Skip to content

Rest API Index

Jump to bottom
Luke Lovett edited this page Oct 16, 2014 · 26 revisions

This page lists all the URIs and HTTP methods that may be used on them. In general, requests and response bodies are sent and received in JSON using the application/json mimetype unless otherwise documented. Mongo Orchestration uses Python's json module, which is a strict JSON parser.

Mongo Orchestration provides a versioned REST API. To send a request to a particular version of a URI, place the version as the first component in that URI: /<version>/rest/of/uri. The current version is v1. Requests to a URI without the version will behave the same as sending a request to the latest version.

There is a links field in every non-empty response body sent from the server. The links field provides a list of related actions and resources to the action or resource requested, which take the following form:

{
    "rel": "rel-name",          // Name of related action or resource
    "href": "/path/to/the/rel", // Path to the action or resource
    "method": "http-method",    // HTTP method to use to retrieve action or resource
    "template": {
        // template for request body
    }
}

In every list of links, there is one whose rel is self to identify the action or resource that was requested.

API v1

/v1 may be prepended to the following to send a request to this version of the API.

Servers

Replica Sets

Sharded Clusters

Releases

Clone this wiki locally