-
Notifications
You must be signed in to change notification settings - Fork 85
/
Copy pathatlas-api-cloudBackups-getExportBucket.txt
99 lines (76 loc) · 3.37 KB
/
atlas-api-cloudBackups-getExportBucket.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
.. _atlas-api-cloudBackups-getExportBucket:
======================================
atlas api cloudBackups getExportBucket
======================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns one Export Bucket associated with the specified Project.
To use this resource, the requesting Service Account or API Key must have the Project Read Only role.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket.
For more information and examples, see the referenced API documentation linked above.
Syntax
------
.. code-block::
:caption: Command Syntax
atlas api cloudBackups getExportBucket [options]
.. Code end marker, please don't delete this comment
Options
-------
.. list-table::
:header-rows: 1
:widths: 20 10 10 60
* - Name
- Type
- Required
- Description
* - --envelope
- envelope
- false
- 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.
* - --exportBucketId
- string
- true
- Unique 24-hexadecimal character string that identifies the Export Bucket.
* - --groupId
- string
- true
- 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 getExportBucket
* - -o, --output
- string
- false
- preferred api format, can be ["json", go-template] This value defaults to "json".
* - --outputFile
- string
- false
- file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
* - --version
- string
- false
- api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30".
Inherited Options
-----------------
.. list-table::
:header-rows: 1
:widths: 20 10 10 60
* - 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.
Examples
--------
.. code-block::
atlas api cloudBackups getExportBucket --version 2024-05-30 --exportBucketId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8
.. Code end marker, please don't delete this comment