> ## Documentation Index
> Fetch the complete documentation index at: https://clumio.reclear.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Clumio REST API

> Authenticate, choose a regional base URL, and use endpoint reference alongside developer workflows.

Use the Clumio REST API to automate protection, discovery, restores, inventory, and administration. This
page puts API conventions and representative endpoint pages beside the developer guides that explain
when to use them.

<Warning>
  This page is a Reclear proof of concept based on public Clumio documentation. The request below has
  not been tested against a live tenant.
</Warning>

<CardGroup cols={2}>
  <Card title="Create an API token" icon="key" href="/developer-tools/authentication">
    Create a personal or service token and plan credential rotation.
  </Card>

  <Card title="Full endpoint reference" icon="book" href="https://api.commvault.com/docs/latest/api/cv/ClumioAPIs/clumio-rest-api/" arrow>
    Open the canonical reference for every resource, operation, request field, and response schema.
  </Card>
</CardGroup>

## Send a request

1. Create a token in **Administration → Access management → API tokens**.
2. Choose the API base URL for the control plane that issued the token.
3. Send the token in the `Authorization` header.

```bash theme={null}
curl "https://us-west-2.api.clumio.com/users" \
  -H "Authorization: Bearer ${CLUMIO_API_TOKEN}"
```

See [Supported regions](/reference/regions#api-base-urls) for the published regional base URLs.

## API conventions

| Convention     | What to expect                                            |
| -------------- | --------------------------------------------------------- |
| Authentication | A signed JSON Web Token sent as a bearer token            |
| Versioning     | Resource versions selected through the `Accept` header    |
| Responses      | HAL links connect related resources and available actions |
| Pagination     | List responses expose the next page through `_links.next` |

Use the endpoint reference for the exact media type, parameters, request body, response schema, and
errors for each operation. The representative pages below show how those details can sit beside
task-based guides in one developer docs experience.

## Example endpoints

<CardGroup cols={3}>
  <Card title="GET /" icon="magnifying-glass" href="/api-reference/discovery">
    Discover available resources, versions, and operation IDs.
  </Card>

  <Card title="GET /users" icon="users" href="/api-reference/users/list-users">
    List users with filtering and pagination.
  </Card>

  <Card title="GET /tasks" icon="list-check" href="/api-reference/tasks/list-tasks">
    List backup, restore, and management tasks.
  </Card>
</CardGroup>

## Choose an interface

<CardGroup cols={2}>
  <Card title="Python SDK" icon="python" href="/developer-tools/python-sdk">
    Use an object-oriented client for Clumio resources.
  </Card>

  <Card title="Go SDK" icon="golang" href="/developer-tools/go-sdk">
    Use typed controllers and models for Clumio resources.
  </Card>

  <Card title="Terraform" icon="cube" href="/developer-tools/terraform">
    Manage connections and protection as code.
  </Card>

  <Card title="Developer tools" icon="code" href="/developer-tools/overview">
    Compare every public automation surface in one place.
  </Card>
</CardGroup>

## Common workflows

* [Define backup policies](/protect/policies)
* [Restore data](/restore/overview)
* [Review audit activity](/administer/audit)
