# API quick reference

> API quick reference - A quick reference to the Workload API endpoint groups and authentication
> baseline.

This Markdown file sits beside the HTML page at the same path (with a `.md` suffix). It summarizes the topic and lists links for tools and LLM context.

Companion generated at `2026-06-22T16:50:38.247525+00:00` (UTC).

## Primary page

- [API quick reference](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/api-quick-reference.html.md): Full documentation for this topic (Markdown sidecar).

## Sections on this page

- [Authentication](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/api-quick-reference.html.md#authentication): In-page section heading.
- [Endpoint groups](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/api-quick-reference.html.md#endpoint-groups): In-page section heading.
- [Resource APIs](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/api-quick-reference.html.md#resource-apis): In-page section heading.
- [Telemetry and access](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/api-quick-reference.html.md#telemetry-and-access): In-page section heading.

## Related documentation

- [Workload API](https://docs.datarobot.com/en/docs/workload-api/index.html.md): Linked from this page.
- [Get started: Workload API](https://docs.datarobot.com/en/docs/workload-api/get-started-workloads/index.html.md): Linked from this page.
- [Deployments API reference](https://docs.datarobot.com/en/docs/api/reference/public-api/tag-deployment-management.html.md): Linked from this page.
- [Replace and roll out](https://docs.datarobot.com/en/docs/workload-api/update-workloads/replace-artifact-rollouts.html.md): Linked from this page.
- [Create and read](https://docs.datarobot.com/en/docs/workload-api/create-workloads/workloads-rest-endpoints.html.md): Linked from this page.
- [Operate](https://docs.datarobot.com/en/docs/workload-api/operate-workloads/operate-rest-endpoints.html.md): Linked from this page.
- [Update](https://docs.datarobot.com/en/docs/workload-api/update-workloads/update-rest-endpoints.html.md): Linked from this page.
- [REST: artifacts and repositories](https://docs.datarobot.com/en/docs/workload-api/build-artifacts/artifacts-rest-endpoints.html.md): Linked from this page.
- [Artifact concepts](https://docs.datarobot.com/en/docs/workload-api/build-artifacts/artifacts-concepts.html.md): Linked from this page.
- [Monitoring concepts](https://docs.datarobot.com/en/docs/workload-api/monitor-workloads/monitoring-concepts.html.md): Linked from this page.
- [Sharing and access control](https://docs.datarobot.com/en/docs/workload-api/operate-workloads/sharing-access-control.html.md): Linked from this page.

## Documentation content

The following provides a quick map of the Workload API REST surface, organized by endpoint group.

> [!NOTE] MLOps deployment API
> Model and custom-model deployments (for example `/api/v2/deployments/`) are not part of the Workload API. Use Workloads and artifacts for governed container runtimes; use the [Deployments API reference](https://docs.datarobot.com/en/docs/api/reference/public-api/tag-deployment-management.html.md) for classic prediction deployments.

## Authentication

All API requests require Bearer token authentication:

```
Authorization: Bearer YOUR_API_TOKEN
```

## Endpoint groups

The Workload API is organized into endpoint groups, each with a specific purpose, with telemetry and access control spanning all of them.

### Resource APIs

The following describes the top-level base API paths and what those paths cover.

| Group | Base path | Capabilities | REST index |
| --- | --- | --- | --- |
| Workloads | /workloads | CRUD; start/stop; promotion; runtime settings (rollouts follow Replace and roll out); statistics with reset-by-window; events; replacement history; related entities; nested protons (including per-replica statusDetails). | Create and read, Operate, Update |
| Artifacts | /artifacts | CRUD; draft vs. locked status; image builds (POST/GET /artifacts/{id}/builds); build inspection; POST /artifacts/{id}/clone. | REST: artifacts and repositories |
| Artifact repositories | /artifactRepositories | Repository metadata; artifact version history; discovery (see Artifact concepts). | REST: artifacts and repositories |

### Telemetry and access

The Workload-scoped observability and role APIs span the preceding resource groups.

| Feature | Location | Reference |
| --- | --- | --- |
| Telemetry | Workload-scoped OpenTelemetry (logs, metrics, traces) | Monitoring concepts |
| Shared roles | sharedRoles under Workloads, artifacts, and artifact repositories | Sharing and access control (SharingRole, update payload) |