Rest API Index

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.

API v1

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

Servers

• /servers [POST, GET]
  • /servers/{server-id} [PUT, POST, GET, DELETE]

Replica Sets

• /replica_sets [POST]
  • /replica_sets/{repl-id} [PUT, GET, DELETE]
    • /replica_sets/{repl-id}/members [GET, POST, DELETE]
      • /replica_sets/{repl-id}/members/{member-id} [GET, PUT, DELETE]
      • /replica_sets/{repl-id}/primary [GET, PUT, DELETE]
      • /replica_sets/{repl-id}/secondaries [GET, DELETE]
      • /replica_sets/{repl-id}/arbiters [GET, DELETE]
      • /replica_sets/{repl-id}/hidden [GET, DELETE]

Sharded Clusters

• /sharded_clusters [POST]
  • /sharded_clusters/{cluster-id} [PUT, GET, DELETE]
    • /sharded_clusters/{cluster-id}/shards [GET, POST]
      • /sharded_clusters/{cluster-id}/shards/{shard-id} [GET, DELETE]
    • /sharded_clusters/{cluster-id}/configservers [GET]
    • /sharded_clusters/{cluster-id}/routers [GET, POST]