# CSIRO Collection Download API

**Canonical:** https://apis.io/apis/csiro/csiro-collection-download-api/  
**Provider:** CSIRO — https://apis.io/providers/csiro/  
**Base URL:** https://data.csiro.au/dap/ws/v2  
**Documentation:** https://research.csiro.au/dap/developer-tools/web-services-ws-v2/

CSIRO Collection Download API is one of 20 APIs that [CSIRO](https://apis.io/providers/csiro/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 14 JSON Schema definitions. Tagged areas include Collection Download. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 14 JSON Schemas.

The Collection Download API from CSIRO — 12 operation(s) for collection download.

## Operations (12)

| Method | Path | Summary |
|---|---|---|
| POST | `/ws/v2/collections/{collectionId}/downloadzip` | Retrieve a ZIP of a subset of files in the collection |
| POST | `/ws/v2/collections/{collectionId}/downloadurls` | Retrieve an object with a subset of files in the collection |
| POST | `/ws/v2/collections/download/restricted` | Restricted download request |
| POST | `/ws/v2/collections/download/restricted/{id}/regenerate` | Regenerate restricted download request |
| POST | `/ws/v2/collections/download/log` | Add download request log |
| POST | `/ws/v2/collections/domain/downloadzip` | This function allows a client to retrieve a ZIP of a subset of files across… |
| POST | `/ws/v2/collections/domain/downloadurls` | Retrieve an object with a subset of files in the collection |
| POST | `/ws/v2/collections/domain/downloadtar` | Retrieve a TAR of a subset of files across different collections |
| GET | `/ws/v2/collections/{id}/licence` | Get collection licence file |
| GET | `/ws/v2/collections/{id}/files/list` | This function allows a client to download a text file with download links for… |
| GET | `/ws/v2/collections/{id}/downloadzip` | This function returns an empty DownloadDto. |
| GET | `/ws/v2/collections/{collectionId}/downloadfile` | This function allows a client to retrieve a single file by name from a… |

## Machine-readable artifacts (17)

- **OpenAPI** — https://artifacts.apis.io/csiro/openapi/csiro-collection-download-api-openapi.yml
- **Documentation** — https://research.csiro.au/dap/developer-tools/
- **APIExplorer** — https://data.csiro.au/dap/swagger-ui.html
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-data-collection-dto-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-casda-metadata-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-casda-observation-search-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-data-collections-result-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-specimen-image-result-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-specimen-image-search-request-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-data-collection-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-my-collection-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-casda-observation-validation-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-doi-files-dataset-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-globus-collection-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-orcid-results-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-orcid-work-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-orcid-user-dto-schema.json

## Other CSIRO APIs (12)

- [CSIRO AAHL API](https://apis.io/apis/csiro/csiro-aahl-api/)
- [CSIRO Api-V2 Admin API](https://apis.io/apis/csiro/csiro-api-v2-admin-api/)
- [CSIRO Api-V2 Authentication API](https://apis.io/apis/csiro/csiro-api-v2-authentication-api/)
- [CSIRO Api-V2 Casda Observations API](https://apis.io/apis/csiro/csiro-api-v2-casda-observations-api/)
- [CSIRO Api-V2 Collections API](https://apis.io/apis/csiro/csiro-api-v2-collections-api/)
- [CSIRO Api-V2 DNA Sequence Collections API](https://apis.io/apis/csiro/csiro-api-v2-dna-sequence-collections-api/)
- [CSIRO Api-V2 Supporting Data API](https://apis.io/apis/csiro/csiro-api-v2-supporting-data-api/)
- [CSIRO Api-V2 User Profile API](https://apis.io/apis/csiro/csiro-api-v2-user-profile-api/)
- [CSIRO Api-V2 User Tasks API](https://apis.io/apis/csiro/csiro-api-v2-user-tasks-api/)
- [CSIRO ATNF API](https://apis.io/apis/csiro/csiro-atnf-api/)
- [CSIRO CASDA API](https://apis.io/apis/csiro/csiro-casda-api/)
- [CSIRO Collection Browse API](https://apis.io/apis/csiro/csiro-collection-browse-api/)

## Tags

Collection Download

---

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