Query your MongoHQ deployments.

The deployments API is a little difference from others we’ve encountered. Firstly, not all plans can use this API. This is only available for larger shared plans, dedicated and custom installs. If you are not certain that if you have any deploys, you can just query the /deployments path.

GET /deployments

Retrieves a list of all deployments in your account.

Required Parameters:

_apikey Your MongoHQ account’s secret key.

Example Request:

curl -X GET https://api.mongohq.com/deployments?_apikey=12345

GET /deployments/:name

Retrieves details about a particular deployment in your account. Note that name is a deployment server name (the domain and port of a server, or the suffix of a replica set), not a database name.

Required Parameters:

_apikey Your MongoHQ account’s secret key.

Example Request:

curl -X GET https://api.mongohq.com/deployments/rose.mongohq.com:9000?_apikey=12345

GET /deployments/:name/logs

Retrieves logs from a particular deployment in your account. Note that name is a deployment server name (the domain and port of a server, or the suffix of a replica set), not a database name.

Required Parameters:

_apikey Your MongoHQ account’s secret key.

Example Request:

curl -X GET https://api.mongohq.com/deployments/rose.mongohq.com:9000/logs?_apikey=12345