/archive
Internal Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /archive/dca | Returns an array containing DCA archival locations, and information specific to them. DCA is a subset of the normal object storage locations, so these DCA locations will also be returned by the /archive/object_store GET API. | Available | |
| POST /archive/dca | Add a new DCA archival location. Initiates an asynchronous job to connect to the archival location. | Restricted | |
| POST /archive/dca/csr | Generates a new private key and return base64 encoded PKCS#10 certificate signing request. If there is a pending DCA CSR, this will invalidate it and create a new one. | Restricted | |
| POST /archive/dca/reader/connect | Connect to an existing DCA archival location as a reader. Initiates an asynchronous job to connect to the archival location. | Available | |
| POST /archive/dca/reconnect | Reconnect to a specific DCA archival location. Initiates an asynchronous job to connect to the archival location. This operation is deprecated. Use /archive/dca/reader/connect instead. | Restricted | |
| GET /archive/dca/{id} | Get information about a specific DCA archival location. | Available | |
| PATCH /archive/dca/{id} | Update the properties of a DCA archival location. | Restricted | |
| GET /archive/location | Retrieve information for all archival locations, including ID, type, status, address, and bucket count. | Available | |
| GET /archive/location/connect_job | Retrieve a list of all running connection and reconnection jobs for archival locations. Returns summary information about the archival location and the job. | Available | |
| GET /archive/location/job/connect/{id} | Retrieve the following information about job: ID of job, job status, error details, start time of job, end time of job, job type, ID of the node, job progress and location id. | Available | |
| GET /archive/location/job/reconnect/{id} | Retrieve the following information about job: ID of job, job status, error details, start time of job, end time of job, job type, ID of the node, job progress and location ID. | Available | |
| GET /archive/location/request/{id} | Returns the details of an asynchronous archival location request issued at an earlier time. | Available | |
| DELETE /archive/location/{id} | Delete the specified archival location. Remove the archival location from the SLA Domains that reference it and expire all snapshots at the archival location. | Restricted | |
| POST /archive/location/{id}/force_delete | REQUIRES SUPPORT TOKEN - Delete a Polaris managed archival location from a CDM cluster outside of the Polaris workflow. A support token is required for this operation. If the archival location is not in the disabled state, it will be disabled first internally as needed. | Restricted | |
| POST /archive/location/{id}/owner/pause | Pause archiving to a specified active archival location of the current Rubrik cluster. | Restricted | |
| POST /archive/location/{id}/owner/resume | Resume archiving to a specified archival location of the current Rubrik cluster. | Restricted | |
| POST /archive/location/{id}/reader/promote | Start an asynchronous job to make the current Rubrik cluster the owner of a reader archival location. After successful completion, the Rubrik cluster that was the previous owner will not have access to the archival location. | Restricted | |
| POST /archive/location/{id}/reader/refresh | Update the current Rubrik cluster with information about the changes made to an archival location by the Rubrik cluster that owns the archival location. | Available | |
| POST /archive/migrate/data_source/{id} | Migrate all unexpired snapshots of a data source from the specified source archival location to a target archival location. At the end of a successful migration, the snapshots are marked as expired on the source location and are Available on the target location. The migrated snapshots on the target location preserve the retention and other attributes as on the source location. | Restricted | |
| GET /archive/migrate/request/{id} | Get the details of an asynchronous archival migration request issued previously. This endpoint is deprecated. Use /archive/location/request/{id} instead. | Restricted | |
| GET /archive/nfs | Retrieve an array of NFS archival location objects for the cluster. | Available | |
| POST /archive/nfs | Add a new NFS archival location. Initiate an asynchronous job to connect to the archival location target. | Restricted | |
| POST /archive/nfs/reader/connect | Connect the current cluster to an existing NFS archival location as a reader. Initiates an asynchronous job to connect to the archival location. | Available | |
| POST /archive/nfs/reconnect | Reconnect to a specific NFS archival location. Initiates an asynchronous job to connect to the archival location. This operation is deprecated. Use /archive/nfs/reader/connect instead. | Restricted | |
| PATCH /archive/nfs/{id} | Update the properties of an NFS archival location. | Restricted | |
| GET /archive/object_store | Retrieve an array of archival locations from the Rubrik cluster. The array contains all object storage locations, but does not include NFS and QStar locations. | Available | |
| POST /archive/object_store | Start an asynchronous job to add a new object storage location. | Restricted | |
| POST /archive/object_store/reader/connect | Connect the current cluster as a reader to an existing object storage location. Initiates an asynchronous job to connect to the archival location. | Available | |
| POST /archive/object_store/reconnect | Reconnect to a specific object storage location. Initiates an asynchronous job to connect to the archival location. This operation is deprecated. Use /archive/object_store/reader/connect instead. | Restricted | |
| GET /archive/object_store/{id} | Get the archival location object for a specific object storage location. | Available | |
| PATCH /archive/object_store/{id} | Update the properties of an object storage location. To update the bucket count, specify a value equal to or greater than the existing bucket count. | Restricted | |
| POST /archive/object_store/{id}/glacier_vault_lock | Update an existing in-progress vault lock operation on a specific Amazon Glacier archival location, by either completing or aborting the current vault lock. | Restricted | |
| GET /archive/qstar | Retrieve an array containing summary information for all QStar archival location objects. | Available | |
| POST /archive/qstar | Add a new QStar archival location object. Initiates an asynchronous job to connect to the archival location. | Restricted | |
| DELETE /archive/qstar | REQUIRES SUPPORT TOKEN - To be used by internal tests to clean the buckets. A support token is required for this operation. | Restricted | |
| POST /archive/qstar/reader/connect | Connect to an existing QStar archival location as a reader. Initiates an asynchronous job to connect to the archival location. | Available | |
| POST /archive/qstar/reconnect | Reconnect to a specified QStar archival location. Initiates an asynchronous job to connect to the archival location. This operation is deprecated. Use /archive/qstar/reader/connect instead. | Restricted | |
| POST /archive/qstar/remove_bucket | REQUIRES SUPPORT TOKEN - To be used by internal tests to remove all QStar buckets matching given prefix. Returns a list of buckets successfully removed. A support token is required for this operation. | Restricted | |
| GET /archive/qstar/{id} | Retrieve summary information for a specified QStar archival location. | Available | |
| PATCH /archive/qstar/{id} | Update the properties of a QStar archival location object. | Restricted |
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /archive/aws/s3/{id}/account_id | Get the AWS account ID of an AWS S3 archival location. | Restricted | |
| GET /archive/azure/region | Retrieves all the regions in Azure. | Restricted | |
| POST /archive/azure/resource_group | Retrieves a list of all resource groups associated with Azure storage account credentials. | Restricted | |
| POST /archive/azure/storage_account | Retrieves all the storage accounts for an Azure resource group. | Restricted | |
| POST /archive/azure/subscription | Retrieves all the subscriptions accessible to a specific client app within an Azure tenant. | Restricted | |
| GET /archive/cold_storage_tier | Gets the cold storage tier configuration to be used by the job that tiers existing snapshots for unprotected objects. Currently, this API endpoint can be used only for archival to S3. | Restricted | |
| POST /archive/cold_storage_tier | Sets the cold storage tier configuration to be used by the job that tiers existing snapshots for unprotected objects. Currently, this API endpoint can be used only for archival to S3. | Restricted | |
| POST /archive/csr | Generates a new private key and return base64 encoded PKCS#10 certificate signing request. If there is a pending DCA or LCK CSR, this will invalidate it and create a new one. | Restricted | |
| POST /archive/dca/disable | Disable the DCA feature so users cannot create or manage DCA locations. | Restricted | |
| POST /archive/dca/enable | Enable the DCA feature to allow users to create and manage DCA locations. A user cannot enable the DCA feature if the LCK feature is already enabled or an LCK location exists on the cluster. | Restricted | |
| GET /archive/dca/status | Get the DCA location feature status to check if the DCA location feature is enabled or not. | Available | |
| GET /archive/lck | Returns an array containing LCK archival locations, and information specific to them. LCK is a subset of the normal object storage locations, so these LCK locations will also be returned by the /archive/object_store GET API. | Available | |
| POST /archive/lck | Add a new LCK archival location. Initiates an asynchronous job to connect to the archival location. | Restricted | |
| POST /archive/lck/disable | Disable the LCK feature so users cannot create or manage LCK locations. | Restricted | |
| POST /archive/lck/enable | Enable the LCK feature to allow users to create and manage LCK locations. A user cannot enable the LCK feature if the DCA feature is already enabled or a DCA location exists on the cluster. | Restricted | |
| POST /archive/lck/reader/connect | Connect to an existing LCK archival location as a reader. Initiates an asynchronous job to connect to the archival location. | Available | |
| GET /archive/lck/status | Get the LCK location feature status to check if the LCK location feature is enabled or not. | Available | |
| GET /archive/lck/{id} | Get information about a specific LCK archival location. | Available | |
| PATCH /archive/lck/{id} | Update the properties of an LCK archival location. | Restricted | |
| GET /archive/location/check_cloud_compute_connectivity/request/{id} | Gets the details of the request that was triggered to check the cloud compute connectivity of an archival location. | Available | |
| POST /archive/location/{id}/check_cloud_compute_connectivity | Triggers a background job to perform the cloud compute connectivity check for the specified archival location. | Restricted | |
| POST /archive/location/{id}/owner/disable | Disables archiving and any changes to the data for the specified archival location. This operation disables snapshot upload, snapshot expiration, consolidation, and garbage collection operations on the archival location. | mutation enableTarget | Restricted |
| POST /archive/location/{id}/owner/enable | Enable archiving and other operations that were previously disabled on the specified archival location. | mutation disableTarget | Restricted |
| POST /archive/location/{location_id}/reader/refresh/data_sources | Update the current Rubrik CDM cluster with information about the changes made to a list of data sources in an archival location by the Rubrik CDM cluster that owns the archival location. | mutation refreshTarget | Available |