atlas api dataFederation
Public Preview: please provide feedback: Returns, adds, edits, and removes Federated Database Instances.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
This resource requires your project ID. Changes to federated database instance configurations can affect costs.
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for dataFederation |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Related Commands
atlas api dataFederation createDataFederationPrivateEndpoint - Public Preview: please provide feedback: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects.
atlas api dataFederation createFederatedDatabase - Public Preview: please provide feedback: Creates one federated database instance in the specified project.
atlas api dataFederation createOneDataFederationQueryLimit - Public Preview: please provide feedback: Creates or updates one query limit for one federated database instance.
atlas api dataFederation deleteDataFederationPrivateEndpoint - Public Preview: please provide feedback: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project.
atlas api dataFederation deleteFederatedDatabase - Public Preview: please provide feedback: Removes one federated database instance from the specified project.
atlas api dataFederation deleteOneDataFederationInstanceQueryLimit - Public Preview: please provide feedback: Deletes one query limit for one federated database instance.
atlas api dataFederation downloadFederatedDatabaseQueryLogs - Public Preview: please provide feedback: Downloads the query logs for the specified federated database instance.
atlas api dataFederation getDataFederationPrivateEndpoint - Public Preview: please provide feedback: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project.
atlas api dataFederation getFederatedDatabase - Public Preview: please provide feedback: Returns the details of one federated database instance within the specified project.
atlas api dataFederation listDataFederationPrivateEndpoints - Public Preview: please provide feedback: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project.
atlas api dataFederation listFederatedDatabases - Public Preview: please provide feedback: Returns the details of all federated database instances in the specified project.
atlas api dataFederation returnFederatedDatabaseQueryLimit - Public Preview: please provide feedback: Returns the details of one query limit for the specified federated database instance in the specified project.
atlas api dataFederation returnFederatedDatabaseQueryLimits - Public Preview: please provide feedback: Returns query limits for a federated databases instance in the specified project.
atlas api dataFederation updateFederatedDatabase - Public Preview: please provide feedback: Updates the details of one federated database instance in the specified project.