API Reference

This reference describes the semantics of Arvados resources and how to programatically access Arvados via its REST API. Each resource listed in this section is exposed on the Arvados API server under the /arvados/v1/ path prefix, for example, https://qr1hi.arvadosapi.com/arvados/v1/collections.

Discovery document

The API server publishes a machine-readable description of its endpoints and some additional site configuration values via a JSON-formatted discovery document. This is available at /discovery/v1/apis/arvados/v1/rest, for example https://qr1hi.arvadosapi.com/discovery/v1/apis/arvados/v1/rest. Some Arvados SDKs use the discovery document to generate language bindings.

Workbench examples

Many Arvados Workbench pages, under the the Advanced tab, provide examples of API and SDK use for accessing the current resource .


Next: API Authorization

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.