Create an Online Archive

On this page

Syntax

Request Parameters
Request Path Parameters
Request Query Parameters
Request Body Parameters
Response Elements
Examples
Date Criteria Examples
Custom Criteria Example
Error Codes

You can create an online archive from the API and Atlas UI. You must have the GROUP_DATA_ACCESS_ADMIN (Project Data Access Admin) role to create an online archive.

The Atlas Administration API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. To learn how to configure API access for an Atlas project, see Get Started with the Atlas Administration API.

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.

https://cloud.mongodb.com/api/atlas/v1.0

Syntax

POST /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/onlineArchives

Request Parameters

Request Path Parameters

Path Element	Necessity	Description
`GROUP-ID`	Required	Unique identifier for the project that contains the specified cluster.
`CLUSTER-NAME`	Required	Name of the cluster that contains the collection for which you want to create an online archive.

Request Query Parameters

This endpoint might use any of the HTTP request query parameters available to all Atlas Administration API resources. All of these are optional.

Name

Type

Necessity

Description

Default

pretty

boolean

Optional

Flag indicating whether the response body should be in a prettyprint format.

false

envelope

boolean

Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:


status	HTTP response code
envelope	Expected response body

false

Request Body Parameters

Name	Type	Necessity	Description
`collName`	string	Required	Name of the collection for which to create an online archive.
`collectionType`	string	Optional	Type of collection. Value can be one of the following: `STANDARD` - for a standard collection `TIMESERIES` - for a time series collection If value is `TIMESERIES`: `criteria.type` must be `date` `criteria.dateFormat` must be `ISODATE` Important Preview Online Archive for timeseries collection is available as a Preview. The feature and corresponding documentation may change at any time in the Preview stage. If omitted, defaults to `STANDARD`.
`dbName`	string	Required	Name of the database that contains the collection.
`criteria`	object	Required	Criteria to use for archiving data.
`criteria.type`	string	Required	Type of criteria. Value can be one of the following: `DATE` - to select documents for archiving based on a date. `CUSTOM` - to select documents for archiving based on a custom JSON query. This is not supported for time series collections.
`criteria.dateField`	string	Conditional	Required if `criteria.type` is `DATE`. Name of an already indexed date field from the documents. For a time series collection, field name must correspond to the `timeField` in the time series collection. Data is archived when the current date is greater than the value of the date field specified here plus the number of days specified via the `expireAfterDays` parameter.
`criteria.dateFormat`	enum	Optional	If `criteria.type` is `DATE`, the date format. Value can be one of the following: `ISODATE` - ISO-8601 format date (default) `EPOCH_SECONDS` - Unix timestamp in seconds `EPOCH_MILLIS` - Unix timestamp in milliseconds `EPOCH_NANOSECONDS` - Unix timestamp in nanoseconds Only `ISODATE` is supported for time series collections. If omitted, defaults to `ISODATE`.
`criteria.expireAfterDays`	int	Conditional	Required if `criteria.type` is `DATE`. Number of days that specifies the age limit for the data in the live Atlas cluster. Data is archived when the current date is greater than the value of the date field specified via the `dateField` parameter plus the number of days specified here.
`criteria.query`	string	Conditional	Required if `criteria.type` is `CUSTOM`. JSON query to use to select documents for archiving. Atlas uses the specified query with the db.collection.find (query) command. The empty document `{}` to return all documents is not supported.
`dataExpirationRule`	object	Optional	Rule for specifying when data should be deleted from the archive. This data expiration rule takes effect only after 24 hours.
`dataExpirationRule.expireAfterDays`	int	Required	Number of days after which Atlas must delete archived data. Value can be between `7` and `9125` days (25 years). Atlas deletes archived data after the number of days you specify here.
`partitionFields`	document array	Optional	Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.
`partitionFields.fieldName`	string	Required	Name of the field. To specify a nested field, use the dot notation.
`partitionFields.order`	int	Required	Position of the field in the partition. Value can be: `0` - for the first position `1` - for the second position `2` - for the third position By default, the date field specified in the `criteria.dateField` parameter is in the first position of the partition.

Response Elements

Name

Type

Description

string

ID of the online archive.

clusterName

string

Name of the cluster that contains the collection.

collName

string

Name of the collection.

collectionType

string

Type of collection. Value can be one of the following:

STANDARD - for standard collection
TIMESERIES - for time series collection
Important
Preview
Online Archive for timeseries collection is available as a Preview. The feature and corresponding documentation may change at any time in the Preview stage.

criteria

document

Criteria to use for archiving data.

criteria.type

string

Type of criteria. Value can be one of the following:

DATE - to select documents for archiving based on a date.
CUSTOM - to select documents for archiving based on a custom JSON query.

criteria.dateField

string

If "criteria.type" : "DATE", name of the date field that the online archive is based on. Data is archived when the current date is after the date specified here plus the number of days specified via the expireAfterDays parameter.

criteria.dateFormat

enum

If "criteria.type" : "DATE", the date format. Value can be one of the following:

ISODATE - ISO-8601 format date (default)
EPOCH_SECONDS - Unix timestamp in seconds
EPOCH_MILLIS - Unix timestamp in milliseconds
EPOCH_NANOSECONDS - Unix timestamp in nanoseconds

criteria.expireAfterDays

int

If "criteria.type" : "DATE", number of days that specifies the age limit for the data in the live Atlas cluster. Data is archived when the current date is greater than the value of the date field specified via the dateField parameter plus the number of days specified here.

criteria.query

int

If "criteria.type" : "CUSTOM", JSON query used to select documents for archiving. The specified query is used with the db.collection.find(query) command.

dataExpirationRule

object

Rule that specifies when data should be deleted from the archive. The data expiration rule takes effect only after 24 hours.

dataExpirationRule.expireAfterDays

int

Number of days after which Atlas must delete archived data. Value can be between 7 and 9125 days (25 years). Atlas deletes archived data after the number of days you specify here.

dbName

string

Name of the database that contains the collection.

groupId

string

Unique identifier of the project that contains the cluster.

partitionFields

document array

Fields to use to partition data.

partitionFields.fieldName

string

Name of the field.

partitionFields.fieldType

string

Data type of the field.

partitionFields.order

int

Position of the field in the partition. Value can be:

0 - for the first position
1 - for the second position
2 - for the third position

paused

boolean

State of the online archive. Value is:

true if the online archive is in paused state.
false if the online archive is in pending or active state.

state

string

Status of the online archive. Valid values are:


Pending	Indicates documents are queued for archive, but archiving has not yet started.
Archiving	Indicates archiving has started. In this state, the documents that meet the criteria for archiving are being archived.
Idle	Indicates online archive is waiting for the next archival job to start.
Pausing	Indicates that you have requested to pause archiving. In this state, Atlas is finishing the running archiving operation and therefore, Atlas has not yet put archiving on hold. The online archive transitions to the `Paused` state when the running archiving operation finishes.
Paused	Indicates archiving has been temporarily stopped. In this state, previously archived documents continue to be available on the cloud object storage for querying, but the specified archiving operation on the active cluster is put on hold and additional documents are not archived. You can resume archiving for paused archives at any time.
Orphaned	Indicates collection associated with an active or paused online archive was deleted. Atlas will not automatically delete the archived data. You must manually delete the online archives associated with the deleted collection.
Deleted	Indicates online archive was deleted. When you delete an online archive, associated archived documents are removed from the cloud object storage.

Examples

Date Criteria Examples

Custom Criteria Example

The following example request creates an online archive for an example people.employees collection in a cluster named myTestClstr. Documents in the collection will be selected for archiving based on a custom query and data is partitioned based on the firstName and lastName fields.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Content-Type: application/json" \
--include \
--request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/5e2211c17a3e5a48f5497de3/clusters/myTestClstr/onlineArchives?pretty=true" \
--data '
{
     "dbName": "people",
     "collName": "employees",
     "partitionFields": [
           {
                   "fieldName": "firstName",
                   "order": 0
           },
           {
                   "fieldName": "lastName",
                   "order": 1
           }],
     "criteria": {
           "type": "CUSTOM",
           "query": "{ \"department\": \"engineering\" }"
     }
}'

Example Response

{
  "_id": "5f9856146b3c0c4e454b9409",
  "clusterName": "osTest",
  "collName": "employees",
  "collectionType": "STANDARD",
  "criteria": {
     "type": "CUSTOM",
     "query": "{department: engineering}"
  },
  "dbName": "people",
  "groupId": "5e2211c17a3e5a48f5497de3",
  "partitionFields": [
     {
         "fieldName": "name.firstName",
         "fieldType": null,
         "order": 0
     },
     {
         "fieldName": "name.lastName",
         "fieldType": null,
         "order": 1
     }
  ],
  "paused": false,
  "state": "PENDING"
}

Error Codes

If the request fails, it returns one of the following errors:

Error Code	Description
`INVALID_GROUP_ID`	The specified project ID is not valid.
`CLUSTER_NOT_FOUND`	There is no cluster with the specified name in the specified project.
`CLUSTER_DELETE_REQUESTED`	The cluster for the online archive is being deleted.
`ONLINE_ARCHIVE_ALREADY_EXISTS`	An online archive with identical settings already exists.
`NAMESPACE_HAS_ONLINE_ARCHIVE`	The collection has another active online archive and so, an online archive with the specified criteria can't be created.
`RESOURCE_NOT_FOUND`	The specified archive ID is not valid.

← Download Online Archive Query Logs Add One Private Endpoint →