---
title: "Describe the deployment"
method: GET
path: "/api/v1/"
tags: ["System"]
---

# Describe the deployment

`GET /api/v1/`

## Request

- Base URL: `https://pcp.example.com`
- URL: `https://pcp.example.com/api/v1/`
- Auth: none required

Returns the version and, to a caller who may read the control plane, the deployment quota and usage.

## Response `200`

OK

- RootResponse: RootResponse schema
  - `enrolled` boolean
  - `license` object, nullable
    - `expires_at` string, date-time
    - `identity_id` string, uuid
    - `issued_at` string, date-time
    - `mode` string, nullable
    - `organization_id` string, uuid
    - `plan` string
    - `quota_hard` integer
    - `quota_soft` integer
  - `name` string
  - `stored_bytes` integer, nullable
  - `version` string

## Other responses

- `400`: Bad Request _(validation or deserialization error)_
- `500`: Internal Server Error _(panics)_
- `default`

---

[API](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1.md) - [All operations](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1/revisions/2ac049494a01?raw)
