Update One Online Archive
Updates, pauses, or resumes 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})$. -
Unique 24-hexadecimal digit string that identifies the online archive to update.
Format should match the following pattern:
^([a-f0-9]{24})$. -
Human-readable label that identifies the cluster that contains the specified collection from which Application created the 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
Updates, pauses, or resumes one online archive.
-
Rule for specifying when data should be deleted from the archive.
-
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 PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/onlineArchives/{archiveId}' \ --header "Authorization: Bearer $ACCESS_TOKEN" \ --header "Content-Type: application/json" \ --data '{"criteria":{"type":"DATE","dateField":"string","dateFormat":"ISODATE","expireAfterDays":42},"dataExpirationRule":{"expireAfterDays":42},"dataProcessRegion":{"cloudProvider":"AWS"},"paused":true,"schedule":{"type":"DEFAULT"}}'{ "criteria": { "type": "DATE", "dateField": "string", "dateFormat": "ISODATE", "expireAfterDays": 42 }, "dataExpirationRule": { "expireAfterDays": 42 }, "dataProcessRegion": { "cloudProvider": "AWS" }, "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" }