Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
27 changes: 17 additions & 10 deletions docs/command/atlas-api-accessTracking-getAccessHistoryCluster.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,35 +47,37 @@ Options
* - --authResult
-
- false
- flag that indicates whether the response returns the successful authentication attempts only
- Flag that indicates whether the response returns the successful authentication attempts only.
* - --clusterName
- string
- true
- human-readable label that identifies the cluster
- Human-readable label that identifies the cluster.
* - --end
- int
- false
- date and time when to stop retrieving database history
- Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.
* - --envelope
-
- envelope
- false
- flag that indicates whether Application wraps the response in an envelope JSON object
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
* - --groupId
- string
- true
- unique 24-hexadecimal digit string that identifies your project
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
* - -h, --help
-
- false
- help for getAccessHistoryCluster
* - --ipAddress
- string
- false
- one Internet Protocol address that attempted to authenticate with the database
- One Internet Protocol address that attempted to authenticate with the database.
* - --nLogs
- int
- false
- maximum number of lines from the log to return
- Maximum number of lines from the log to return.
* - -o, --output
- string
- false
Expand All @@ -87,11 +89,11 @@ Options
* - --pretty
-
- false
- flag that indicates whether the response body should be in the prettyprint format
- Flag that indicates whether the response body should be in the prettyprint format.
* - --start
- int
- false
- date and time when MongoDB Cloud begins retrieving database history
- Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.
* - --version
- string
- false
Expand All @@ -113,3 +115,8 @@ Inherited Options
- 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.

Examples
--------

.. literalinclude:: /includes/examples/atlas-api-accessTracking-getAccessHistoryCluster-2023-01-01-default.sh
:language: shell
27 changes: 17 additions & 10 deletions docs/command/atlas-api-accessTracking-getAccessHistoryProcess.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,35 +47,37 @@ Options
* - --authResult
-
- false
- flag that indicates whether the response returns the successful authentication attempts only
- Flag that indicates whether the response returns the successful authentication attempts only.
* - --end
- int
- false
- date and time when to stop retrieving database history
- Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.
* - --envelope
-
- envelope
- false
- flag that indicates whether Application wraps the response in an envelope JSON object
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
* - --groupId
- string
- true
- unique 24-hexadecimal digit string that identifies your project
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
* - -h, --help
-
- false
- help for getAccessHistoryProcess
* - --hostname
- string
- true
- fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download
- Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.
* - --ipAddress
- string
- false
- one Internet Protocol address that attempted to authenticate with the database
- One Internet Protocol address that attempted to authenticate with the database.
* - --nLogs
- int
- false
- maximum number of lines from the log to return
- Maximum number of lines from the log to return.
* - -o, --output
- string
- false
Expand All @@ -87,11 +89,11 @@ Options
* - --pretty
-
- false
- flag that indicates whether the response body should be in the prettyprint format
- Flag that indicates whether the response body should be in the prettyprint format.
* - --start
- int
- false
- date and time when MongoDB Cloud begins retrieving database history
- Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.
* - --version
- string
- false
Expand All @@ -113,3 +115,8 @@ Inherited Options
- 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.

Examples
--------

.. literalinclude:: /includes/examples/atlas-api-accessTracking-getAccessHistoryProcess-2023-01-01-default.sh
:language: shell
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,19 @@ Options
- Required
- Description
* - --envelope
-
- envelope
- false
- flag that indicates whether Application wraps the response in an envelope JSON object
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
* - --file
- string
- false
- path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
* - --groupId
- string
- true
- unique 24-hexadecimal digit string that identifies your project
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
* - -h, --help
-
- false
Expand All @@ -74,7 +76,7 @@ Options
* - --pretty
-
- false
- flag that indicates whether the response body should be in the prettyprint format
- Flag that indicates whether the response body should be in the prettyprint format.
* - --version
- string
- false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,17 @@ Options
* - --alertConfigId
- string
- true
- unique 24-hexadecimal digit string that identifies the alert configuration
- Unique 24-hexadecimal digit string that identifies the alert configuration.
* - --envelope
-
- envelope
- false
- flag that indicates whether Application wraps the response in an envelope JSON object
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
* - --groupId
- string
- true
- unique 24-hexadecimal digit string that identifies your project
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
* - -h, --help
-
- false
Expand All @@ -74,7 +76,7 @@ Options
* - --pretty
-
- false
- flag that indicates whether the response body should be in the prettyprint format
- Flag that indicates whether the response body should be in the prettyprint format.
* - --version
- string
- false
Expand All @@ -96,3 +98,8 @@ Inherited Options
- 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.

Examples
--------

.. literalinclude:: /includes/examples/atlas-api-alertConfigurations-deleteAlertConfig-2023-01-01-default.sh
:language: shell
17 changes: 12 additions & 5 deletions docs/command/atlas-api-alertConfigurations-getAlertConfig.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,17 @@ Options
* - --alertConfigId
- string
- true
- unique 24-hexadecimal digit string that identifies the alert configuration
- Unique 24-hexadecimal digit string that identifies the alert configuration.
* - --envelope
-
- envelope
- false
- flag that indicates whether Application wraps the response in an envelope JSON object
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
* - --groupId
- string
- true
- unique 24-hexadecimal digit string that identifies your project
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
* - -h, --help
-
- false
Expand All @@ -74,7 +76,7 @@ Options
* - --pretty
-
- false
- flag that indicates whether the response body should be in the prettyprint format
- Flag that indicates whether the response body should be in the prettyprint format.
* - --version
- string
- false
Expand All @@ -96,3 +98,8 @@ Inherited Options
- 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.

Examples
--------

.. literalinclude:: /includes/examples/atlas-api-alertConfigurations-getAlertConfig-2023-01-01-default.sh
:language: shell
23 changes: 15 additions & 8 deletions docs/command/atlas-api-alertConfigurations-getAlertConfigs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,27 +50,29 @@ Options
* - --alertId
- string
- true
- unique 24-hexadecimal digit string that identifies the alert
- Unique 24-hexadecimal digit string that identifies the alert.
* - --envelope
-
- envelope
- false
- flag that indicates whether Application wraps the response in an envelope JSON object
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
* - --groupId
- string
- true
- unique 24-hexadecimal digit string that identifies your project
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
* - -h, --help
-
- false
- help for getAlertConfigs
* - --includeCount
-
- false
- flag that indicates whether the response returns the total number of items (totalCount) in the response
- Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.
* - --itemsPerPage
- int
- false
- number of items that the response returns per page
- Number of items that the response returns per page.
* - -o, --output
- string
- false
Expand All @@ -82,11 +84,11 @@ Options
* - --pageNum
- int
- false
- number of the page that displays the current set of the total objects that the response returns
- Number of the page that displays the current set of the total objects that the response returns.
* - --pretty
-
- false
- flag that indicates whether the response body should be in the prettyprint format
- Flag that indicates whether the response body should be in the prettyprint format.
* - --version
- string
- false
Expand All @@ -108,3 +110,8 @@ Inherited Options
- 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.

Examples
--------

.. literalinclude:: /includes/examples/atlas-api-alertConfigurations-getAlertConfigs-2023-01-01-default.sh
:language: shell
21 changes: 14 additions & 7 deletions docs/command/atlas-api-alertConfigurations-listAlertConfigs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,25 +48,27 @@ Options
- Required
- Description
* - --envelope
-
- envelope
- false
- flag that indicates whether Application wraps the response in an envelope JSON object
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
* - --groupId
- string
- true
- unique 24-hexadecimal digit string that identifies your project
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
* - -h, --help
-
- false
- help for listAlertConfigs
* - --includeCount
-
- false
- flag that indicates whether the response returns the total number of items (totalCount) in the response
- Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.
* - --itemsPerPage
- int
- false
- number of items that the response returns per page
- Number of items that the response returns per page.
* - -o, --output
- string
- false
Expand All @@ -78,11 +80,11 @@ Options
* - --pageNum
- int
- false
- number of the page that displays the current set of the total objects that the response returns
- Number of the page that displays the current set of the total objects that the response returns.
* - --pretty
-
- false
- flag that indicates whether the response body should be in the prettyprint format
- Flag that indicates whether the response body should be in the prettyprint format.
* - --version
- string
- false
Expand All @@ -104,3 +106,8 @@ Inherited Options
- 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.

Examples
--------

.. literalinclude:: /includes/examples/atlas-api-alertConfigurations-listAlertConfigs-2023-01-01-default.sh
:language: shell
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ Options
- Required
- Description
* - --envelope
-
- envelope
- false
- flag that indicates whether Application wraps the response in an envelope JSON object
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
* - -h, --help
-
- false
Expand All @@ -63,7 +63,7 @@ Options
* - --pretty
-
- false
- flag that indicates whether the response body should be in the prettyprint format
- Flag that indicates whether the response body should be in the prettyprint format.
* - --version
- string
- false
Expand Down
Loading
Loading