STACKIT MongoDB Service API
This is the documentation for the STACKIT MongoDB Flex Service API
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is the documentation for the STACKIT MongoDB Flex Service API
Endpoints 25
- GETFlavors
/v2/projects/:projectId/regions/:region/flavorsreturns all possible flavors - GETList Instances
/v2/projects/:projectId/regions/:region/instances?tag=stringlist all instances for a projectID - POSTCreate instance
/v2/projects/:projectId/regions/:region/instancesCreate and deploys an instance<br/> Note that the time format for the backupSchedule is in UTC - GETGet instance
/v2/projects/:projectId/regions/:region/instances/:instanceIdgets information of an instance - PUTPut endpoint
/v2/projects/:projectId/regions/:region/instances/:instanceIdUpdates a deployment plan<br/> Note that the time format for the backupSchedule is in UTC - DELETEDelete instance
/v2/projects/:projectId/regions/:region/instances/:instanceIdremoves an instance - PATCHPatch endpoint
/v2/projects/:projectId/regions/:region/instances/:instanceIdUpdates a deployment plan<br/> Note that the time format for the backupSchedule is in UTC - GETGet slow queries
/v2/projects/:projectId/regions/:region/instances/:instanceId/advisor/slow-queriesgets slow queries from the Opsmanager performance advisor - GETGet suggested indexes
/v2/projects/:projectId/regions/:region/instances/:instanceId/advisor/suggested-indexesgets suggested indexes from the Opsmanager performance advisor - GETList backup
/v2/projects/:projectId/regions/:region/instances/:instanceId/backupsList backups of an instance - PUTUpdate schedule
/v2/projects/:projectId/regions/:region/instances/:instanceId/backupsUpdates a backup schedule<br/> Note that the time format is in UTC - GETGet backup
/v2/projects/:projectId/regions/:region/instances/:instanceId/backups/:backupIdGet details about a specific backup - POSTClone instance
/v2/projects/:projectId/regions/:region/instances/:instanceId/cloneClone an instance via PIT restore<br/> Note that the Timestamp is a RFC3339 standard and uses by default UTC time format<br/> As an example a valid timestamp… - GETMetrics
/v2/projects/:projectId/regions/:region/instances/:instanceId/metrics/:metric?granularity=stringreturns metrics for an instance - GETList restore jobs
/v2/projects/:projectId/regions/:region/instances/:instanceId/restoresList restore jobs of an instance - POSTRestore instance
/v2/projects/:projectId/regions/:region/instances/:instanceId/restoresRestore an instance based on snapshot - GETList Users
/v2/projects/:projectId/regions/:region/instances/:instanceId/userslist all users for a mongodb instance - POSTCreate User
/v2/projects/:projectId/regions/:region/instances/:instanceId/userscreate a new user for a mongodb instance - GETGet User
/v2/projects/:projectId/regions/:region/instances/:instanceId/users/:userIdget detailed information of a user of a mongodb instance - PUTUpdate User
/v2/projects/:projectId/regions/:region/instances/:instanceId/users/:userIdupdates user for a mongodb instance - DELETEDelete User
/v2/projects/:projectId/regions/:region/instances/:instanceId/users/:userIddelete mongodb user - PATCHUpdate User
/v2/projects/:projectId/regions/:region/instances/:instanceId/users/:userIdupdates user for a mongodb instance - POSTReset User
/v2/projects/:projectId/regions/:region/instances/:instanceId/users/:userId/resetresets mongodb user's password - GETGet storage
/v2/projects/:projectId/regions/:region/storages/:flavorreturns the storage for a certain flavor - GETGet versions
/v2/projects/:projectId/regions/:region/versionsreturns all available versions for creating endpoint
API details
- Base URL
https://mongodb-flex-service.api.stackit.cloud- Authentication
- None declared in the description
- Operations
- 25 operations on 15 pathsGET 13POST 5PUT 3PATCH 2DELETE 2
- Response formats
application/json*/*- Description format
- OpenAPI 3.0.1, API version
2.0.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- STACKIT's published OpenAPI description (stackitcloud/stackit-api-specifications) (Apache-2.0)
How to test the STACKIT MongoDB Service API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the STACKIT MongoDB Service API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Flavors” (GET /v2/projects/:projectId/regions/:region/flavors), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the STACKIT MongoDB Service API?
This is the documentation for the STACKIT MongoDB Flex Service API It is listed under Developer tools and has 25 endpoints.
Who publishes the STACKIT MongoDB Service API?
It is listed from STACKIT's public API description (an OpenAPI document), not published by STACKIT on Swastik Codes. Anyone who controls stackit.cloud can claim the profile by adding a DNS TXT record.
What is the base URL of the STACKIT MongoDB Service API?
Requests go to https://mongodb-flex-service.api.stackit.cloud. Endpoint paths are added to this base URL.
How do I authenticate with the STACKIT MongoDB Service API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the STACKIT MongoDB Service API have?
25 operations on 15 paths (13 GET, 5 POST, 3 PUT, 2 PATCH, 2 DELETE).
Is forking the STACKIT MongoDB Service API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.