Create One Online Archive
Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role.
Path parameters
-
Unique 24-hexadecimal digit string that identifies your project. Use the /groups 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.
Format should match the following pattern:
^([a-f0-9]{24})$. -
Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.
Format should match the following pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Query parameters
-
Flag that indicates whether Application wraps the response in an
envelopeJSON 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.Default value is
false. -
Flag that indicates whether the response body should be in the prettyprint format.
Default value is
false.Prettyprint
Body Required
Creates one online archive.
-
Human-readable label that identifies the collection for which you created the online archive.
-
Classification of MongoDB database collection that you want to return.
If you set this parameter to
TIMESERIES, set"criteria.type" : "date"and"criteria.dateFormat" : "ISODATE".Values are
TIMESERIESorSTANDARD. Default value isSTANDARD. -
Rule for specifying when data should be deleted from the archive.
-
Human-readable label of the database that contains the collection that contains the online archive.
-
List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you "specified :criteria.type": "DATE" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you "specified :criteria.type": "CUSTOM" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use ":criteria.type": "DATE" or ":criteria.type": "CUSTOM" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.
Metadata to partition this online archive.
At least
1element. -
Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to true. To resume a paused archive, set this to false.
curl \ --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/onlineArchives' \ --header "Authorization: Bearer $ACCESS_TOKEN" \ --header "Content-Type: application/json" \ --data '{"collName":"string","collectionType":"STANDARD","criteria":{"type":"DATE","dateField":"string","dateFormat":"ISODATE","expireAfterDays":42},"dataExpirationRule":{"expireAfterDays":42},"dataProcessRegion":{"cloudProvider":"AWS","region":"US_EAST_1"},"dbName":"string","partitionFields":[{"fieldName":"string","order":0}],"paused":true,"schedule":{"type":"DEFAULT"}}'{ "collName": "string", "collectionType": "STANDARD", "criteria": { "type": "DATE", "dateField": "string", "dateFormat": "ISODATE", "expireAfterDays": 42 }, "dataExpirationRule": { "expireAfterDays": 42 }, "dataProcessRegion": { "cloudProvider": "AWS", "region": "US_EAST_1" }, "dbName": "string", "partitionFields": [ { "fieldName": "string", "order": 0 } ], "paused": true, "schedule": { "type": "DEFAULT" } }{ "_id": "32b6e34b3d91647abb20e7b8", "clusterName": "string", "collName": "string", "collectionType": "STANDARD", "criteria": { "type": "DATE", "dateField": "string", "dateFormat": "ISODATE", "expireAfterDays": 42 }, "dataExpirationRule": { "expireAfterDays": 42 }, "dataProcessRegion": { "cloudProvider": "AWS", "region": "US_EAST_1" }, "dataSetName": "string", "dbName": "string", "groupId": "32b6e34b3d91647abb20e7b8", "partitionFields": [ { "fieldName": "string", "fieldType": "date", "order": 0 } ], "paused": true, "schedule": { "type": "DEFAULT" }, "state": "PENDING" }{ "error": 400, "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", "reason": "Bad Request", "errorCode": "VALIDATION_ERROR" }{ "error": 401, "detail": "(This is just an example, the exception may not be related to this endpoint)", "reason": "Unauthorized", "errorCode": "NOT_ORG_GROUP_CREATOR" }{ "error": 403, "detail": "(This is just an example, the exception may not be related to this endpoint)", "reason": "Forbidden", "errorCode": "CANNOT_CHANGE_GROUP_NAME" }{ "error": 404, "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", "reason": "Not Found", "errorCode": "RESOURCE_NOT_FOUND" }{ "error": 409, "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", "reason": "Conflict", "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK" }{ "error": 500, "detail": "(This is just an example, the exception may not be related to this endpoint)", "reason": "Internal Server Error", "errorCode": "UNEXPECTED_ERROR" }