# COS Registration Server API

**Canonical:** https://apis.io/apis/canonical/cos-registration-server-api/  
**Provider:** Canonical — https://apis.io/providers/canonical/  
**Documentation:** https://github.com/canonical/cos-registration-server

COS Registration Server API is one of 22 APIs that [Canonical](https://apis.io/providers/canonical/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Observability, Robotics, and Edge. The published artifact set on APIs.io includes an OpenAPI specification.

Part of the Canonical Observability Stack for robotics and edge fleets. The registration server API registers devices and manages their per-application configuration — Grafana dashboards, Foxglove layouts and Bag files — across 13 paths and 35 operations, published as OpenAPI 3.0.3.

## Operations (35)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/applications/foxglove/dashboards/` | List Foxglove dashboards |
| POST | `/api/v1/applications/foxglove/dashboards/` | Add a Foxglove dashboard |
| GET | `/api/v1/applications/foxglove/dashboards/{uid}/` | Download Foxglove dashboard JSON file |
| PUT | `/api/v1/applications/foxglove/dashboards/{uid}/` | Update a Foxglove dashboard completely |
| PATCH | `/api/v1/applications/foxglove/dashboards/{uid}/` | Update a Foxglove dashboard partially |
| DELETE | `/api/v1/applications/foxglove/dashboards/{uid}/` | Delete a Foxglove dashboard |
| GET | `/api/v1/applications/grafana/dashboards/` | List Grafana dashboards |
| POST | `/api/v1/applications/grafana/dashboards/` | Add a Grafana dashboard |
| GET | `/api/v1/applications/grafana/dashboards/{uid}/` | Download Grafana dashboard JSON file |
| PUT | `/api/v1/applications/grafana/dashboards/{uid}/` | Update a Grafana dashboard completely |
| PATCH | `/api/v1/applications/grafana/dashboards/{uid}/` | Update a Grafana dashboard partially |
| DELETE | `/api/v1/applications/grafana/dashboards/{uid}/` | Delete a Grafana dashboard |
| GET | `/api/v1/applications/loki/alert_rules/` | List Loki alert rule file |
| POST | `/api/v1/applications/loki/alert_rules/` | Add a Loki alert rule file |
| GET | `/api/v1/applications/loki/alert_rules/{uid}/` | Download Loki alert rule file |
| PUT | `/api/v1/applications/loki/alert_rules/{uid}/` | Update a Loki alert rule file completely |
| PATCH | `/api/v1/applications/loki/alert_rules/{uid}/` | Update a Loki alert rule file partially |
| DELETE | `/api/v1/applications/loki/alert_rules/{uid}/` | Delete a Loki alert rule file |
| GET | `/api/v1/applications/prometheus/alert_rules/` | List Prometheus alert rule file |
| POST | `/api/v1/applications/prometheus/alert_rules/` | Add a Prometheus alert rule file |
| GET | `/api/v1/applications/prometheus/alert_rules/{uid}/` | Download Prometheus alert rule file |
| PUT | `/api/v1/applications/prometheus/alert_rules/{uid}/` | Update a Prometheus alert rule file completely |
| PATCH | `/api/v1/applications/prometheus/alert_rules/{uid}/` | Update a Prometheus alert rule file partially |
| DELETE | `/api/v1/applications/prometheus/alert_rules/{uid}/` | Delete a Prometheus alert rule file |
| GET | `/api/v1/devices/` | List devices |
| POST | `/api/v1/devices/` | Register a device |
| GET | `/api/v1/devices/{uid}/` | Get a device |
| PUT | `/api/v1/devices/{uid}/` | Update a device completely |
| PATCH | `/api/v1/devices/{uid}/` | Update a device partially |
| DELETE | `/api/v1/devices/{uid}/` | Delete a device |
| GET | `/api/v1/devices/{uid}/certificate/` | Check certificate signing status |
| POST | `/api/v1/devices/{uid}/certificate/` | Submit a Certificate Signing Request (CSR) |
| PATCH | `/api/v1/devices/{uid}/certificate/` | Update certificate status (internal use) |
| GET | `/api/v1/health/` | Health |
| GET | `/api/v1/schema/` | — |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-cos-registration-server-api-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/overlays/canonical-cos-registration-server-api-overlay.yaml
- **SourceCode** — https://github.com/canonical/cos-registration-server

## Other Canonical APIs (12)

- [Snap Store API](https://apis.io/apis/canonical/snap-store-api/)
- [Charmhub API](https://apis.io/apis/canonical/charmhub-api/)
- [snapd REST API](https://apis.io/apis/canonical/snapd-rest-api/)
- [MAAS API](https://apis.io/apis/canonical/maas-api/)
- [Juju Client / Controller API](https://apis.io/apis/canonical/juju-api/)
- [Launchpad Web Services API](https://apis.io/apis/canonical/launchpad-api/)
- [Ubuntu Pro Client API](https://apis.io/apis/canonical/ubuntu-pro-api/)
- [Landscape API](https://apis.io/apis/canonical/landscape-api/)
- [Canonical Assertions API](https://apis.io/apis/canonical/canonical-assertions-api/)
- [Canonical Search API](https://apis.io/apis/canonical/canonical-search-api/)
- [Canonical Snaps API](https://apis.io/apis/canonical/canonical-snaps-api/)
- [LXD REST API](https://apis.io/apis/canonical/lxd-rest-api/)

## Tags

Observability, Robotics, Edge

---

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