# Cesium Archives API

**Canonical:** https://apis.io/apis/cesium/cesium-archives-api/  
**Provider:** Cesium — https://apis.io/providers/cesium/  
**Base URL:** https://ion.cesium.com/  
**Documentation:** https://ion.cesium.com/

Cesium Archives API is one of 10 APIs that [Cesium](https://apis.io/providers/cesium/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Archives. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Archives allow you to make downloadable versions of your assets for offline use or hosting outside of Cesium ion. With archives you can: * Create a full copy of an asset as a zip file * Clip out a subset of a 3D Tiles, terrain, or imagery asset as a glTF model or 3D Tiles 1.1 zip file Full asset downloads do not support Asset Depot assets or terrain assets which use a base terrain. Check the [archivable](#operation/getAsset) property of the asset to detect availability. <a name="archive-clip-requirements"></a> Clips support both your assets and most Asset Depot assets, but have additional restrictions: * Clips can only be made from 3D Tiles or terrain & imagery assets. * Clips comprised of your assets have a geographic size limit of 200 km^2 * Clips comprised of Asset Depot assets have a geographic size limit of 25 km^2 * The number of Clips you can make with Asset Depot assets within a billing period is limited by your plan. See [Cesium ion pricing plans](https://cesium.com/platform/cesium-ion/pricing/) for specific limits. Individual archives count against your account storage quota. If your account goes over storage quota, additional archives will not be possible without upgrading your plan or deleting existing archives or assets to free up space.

## Operations (11)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/archives` | List archives |
| POST | `/v1/archives` | Create an archive |
| GET | `/v1/archives/{archiveId}` | Get info about an archive |
| PATCH | `/v1/archives/{archiveId}` | Update an archive name |
| DELETE | `/v1/archives/{archiveId}` | Delete an archive |
| GET | `/v1/archives/{archiveId}/download` | Download an archive |
| GET | `/v1/assets/{assetId}/archives` | List archives for an asset |
| POST | `/v1/assets/{assetId}/archives` | Create an archive |
| GET | `/v1/assets/{assetId}/archives/{archiveId}` | Get info about an archive |
| DELETE | `/v1/assets/{assetId}/archives/{archiveId}` | Delete an archive |
| GET | `/v1/assets/{assetId}/archives/{archiveId}/download` | Download an archive |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/cesium/openapi/cesium-archives-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/cesium/json-schema/cesium-asset-endpoint-schema.json
- **JSONSchema** — https://artifacts.apis.io/cesium/json-schema/cesium-asset-metadata-schema.json
- **JSONSchema** — https://artifacts.apis.io/cesium/json-schema/cesium-token-metadata-schema.json
- **JSONSchema** — https://artifacts.apis.io/cesium/json-schema/cesium-token-metadata-default-token-schema.json
- **JSONSchema** — https://artifacts.apis.io/cesium/json-schema/cesium-external-asset-endpoint-schema.json
- **JSONSchema** — https://artifacts.apis.io/cesium/json-schema/cesium-archive-metadata2-schema.json

## Other Cesium APIs (9)

- [Cesium ion API](https://apis.io/apis/cesium/cesium-ion-api/)
- [Cesium Asset Elements API](https://apis.io/apis/cesium/cesium-asset-elements-api/)
- [Cesium Assets API](https://apis.io/apis/cesium/cesium-assets-api/)
- [Cesium Experimental API](https://apis.io/apis/cesium/cesium-experimental-api/)
- [Cesium Exports API](https://apis.io/apis/cesium/cesium-exports-api/)
- [Cesium Labels API](https://apis.io/apis/cesium/cesium-labels-api/)
- [Cesium OAuth API](https://apis.io/apis/cesium/cesium-oauth-api/)
- [Cesium Tokens API](https://apis.io/apis/cesium/cesium-tokens-api/)
- [Cesium User API](https://apis.io/apis/cesium/cesium-user-api/)

## Tags

Archives

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cesium/cesium-archives-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cesium/.