Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions docs/platform/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,24 +104,24 @@ The v1 API surface is organized into the following logical groups:

| # | Group | Base path(s) | What it covers | Availability |
|---|-------|--------------|----------------|--------------|
| 1 | [Identity: Users & Settings](../api/users-settings/) | `/api/v1/user`, `/api/v1/users` | Accounts, profile/security settings, tokens, credentials | always |
| 2 | [Identity: Organizations & Teams](../api/organizations-teams/) | `/api/v1/orgs`, `/api/v1/teams` | Orgs, members, teams, org tokens | always |
| 3 | [Administration](../api/administration/) | `/api/v1/admin`, `/api/v1/accounts/admin` | Admin console, site settings | always |
| 4 | [Authorization (Roles & Permissions)](../api/authorization/) | `/api/v1/authz` | Custom roles & permissions | always |
| 5 | [Cluster Management (v1 + K8s proxy + Helm)](../api/cluster-management-v1/) | `/api/v1/clusters` | Cluster lifecycle, Kubernetes proxy, Helm | always |
| 6 | [Cluster Management v2](../api/cluster-management-v2/) | `/api/v1/clustersv2` | Hub-aware cluster API, subscriptions, gateways | always |
| 7 | [Multi-cluster (OCM hub/spoke)](../api/multicluster-ocm/) | `/api/v1/clusters/:owner/:cluster/...` | Hub/spoke, cluster sets, feature sets | always |
| 8 | [Client Organizations](../api/client-organizations/) | `/api/v1/user/client*`, `/api/v1/clusters/.../permission` | Managed-service client orgs | always |
| 9 | [Cloud Providers](../api/cloud-providers/) | `/api/v1/clouds` | Provider discovery for provisioning | always |
| 10 | [Platform Installer](../api/ace-installer/) | `/api/v1/ace-installer` | Self-host installer bundles | AppsCode-hosted only |
| 11 | [Platform Upgrade](../api/ace-upgrade/) | `/api/v1/upgrade`, `/api/v1/clusters/.../upgrade` | Platform & cluster upgrades | always |
| 12 | [Licensing & Contracts](../api/licensing-contracts/) | `/api/v1/contracts`, `/api/v1/user/contracts`, `/api/v1/register`, `/api/v1/license` | Contracts, licenses, registration | contracts: AppsCode-hosted |
| 13 | [Billing Dashboard & Usage Reports](../api/billing-dashboard/) | `/api/v1/dashboard`, `/api/v1/user/dashboard`, `/api/v1/dbaas` | Usage reports & billing dashboards | billing-enabled deployments |
| 14 | [Marketplace](../api/marketplace/) | `/api/v1/marketplaces` (separate service), `/api/v1/proxy/metered-billing` | Cloud-marketplace webhooks & metering | marketplace deployments |
| 15 | [Monitoring & Telemetry](../api/monitoring-telemetry/) | `/api/v1/telemetry`, `/api/v1/trickster` | Telemetry stack, Trickster auth proxy | always |
| 16 | [Rancher Integration](../api/rancher/) | `/api/v1/rancher` | Rancher sync & proxy | always |
| 17 | [Helm Chart Repositories (public)](../api/chart-repositories/) | `/api/v1/chartrepositories` | Public Helm chart repositories | always |
| 18 | [Miscellaneous & Site Settings](../api/miscellaneous/) | `/api/v1/version`, `/api/v1/markdown`, `/api/v1/branding`, ... | Version, markdown, health | always |
| 1 | [Identity: Users & Settings](../api/users-settings/overview/) | `/api/v1/user`, `/api/v1/users` | Accounts, profile/security settings, tokens, credentials | always |
| 2 | [Identity: Organizations & Teams](../api/organizations-teams/overview/) | `/api/v1/orgs`, `/api/v1/teams` | Orgs, members, teams, org tokens | always |
| 3 | [Administration](../api/administration/overview/) | `/api/v1/admin`, `/api/v1/accounts/admin` | Admin console, site settings | always |
| 4 | [Authorization (Roles & Permissions)](../api/authorization/overview/) | `/api/v1/authz` | Custom roles & permissions | always |
| 5 | [Cluster Management (v1 + K8s proxy + Helm)](../api/cluster-management-v1/overview/) | `/api/v1/clusters` | Cluster lifecycle, Kubernetes proxy, Helm | always |
| 6 | [Cluster Management v2](../api/cluster-management-v2/overview/) | `/api/v1/clustersv2` | Hub-aware cluster API, subscriptions, gateways | always |
| 7 | [Multi-cluster (OCM hub/spoke)](../api/multicluster-ocm/overview/) | `/api/v1/clusters/:owner/:cluster/...` | Hub/spoke, cluster sets, feature sets | always |
| 8 | [Client Organizations](../api/client-organizations/overview/) | `/api/v1/user/client*`, `/api/v1/clusters/.../permission` | Managed-service client orgs | always |
| 9 | [Cloud Providers](../api/cloud-providers/overview/) | `/api/v1/clouds` | Provider discovery for provisioning | always |
| 10 | [Platform Installer](../api/ace-installer/overview/) | `/api/v1/ace-installer` | Self-host installer bundles | AppsCode-hosted only |
| 11 | [Platform Upgrade](../api/ace-upgrade/overview/) | `/api/v1/upgrade`, `/api/v1/clusters/.../upgrade` | Platform & cluster upgrades | always |
| 12 | [Licensing & Contracts](../api/licensing-contracts/overview/) | `/api/v1/contracts`, `/api/v1/user/contracts`, `/api/v1/register`, `/api/v1/license` | Contracts, licenses, registration | contracts: AppsCode-hosted |
| 13 | [Billing Dashboard & Usage Reports](../api/billing-dashboard/overview/) | `/api/v1/dashboard`, `/api/v1/user/dashboard`, `/api/v1/dbaas` | Usage reports & billing dashboards | billing-enabled deployments |
| 14 | [Marketplace](../api/marketplace/overview/) | `/api/v1/marketplaces` (separate service), `/api/v1/proxy/metered-billing` | Cloud-marketplace webhooks & metering | marketplace deployments |
| 15 | [Monitoring & Telemetry](../api/monitoring-telemetry/overview/) | `/api/v1/telemetry`, `/api/v1/trickster` | Telemetry stack, Trickster auth proxy | always |
| 16 | [Rancher Integration](../api/rancher/overview/) | `/api/v1/rancher` | Rancher sync & proxy | always |
| 17 | [Helm Chart Repositories (public)](../api/chart-repositories/overview/) | `/api/v1/chartrepositories` | Public Helm chart repositories | always |
| 18 | [Miscellaneous & Site Settings](../api/miscellaneous/overview/) | `/api/v1/version`, `/api/v1/markdown`, `/api/v1/branding`, ... | Version, markdown, health | always |

![KubeDB Platform /api/v1 API group map](../api/images/api-groups.svg)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-ace-installer-readme
identifier: api-ace-installer-overview
name: Overview
parent: api-ace-installer
weight: 1
menu_name: docsplatform_{{.version}}
section_menu_id: api
url: /docs/platform/{{.version}}/api/ace-installer/
aliases:
- /docs/platform/{{.version}}/api/ace-installer/overview/
---

# Platform Installer API
Expand Down Expand Up @@ -48,6 +45,6 @@ Generates and manages self-host installer bundles. Token + org context; per-acti

## Pages

- [Platform Installer](../ace-installer.md) — schema/model, generate/import,
- [Platform Installer](../ace-installer) — schema/model, generate/import,
installer metadata and latest version, installers CRUD, reconfigure/upgrade,
versions/archives, and marketplace installer status.
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-ace-upgrade-readme
identifier: api-ace-upgrade-overview
name: Overview
parent: api-ace-upgrade
weight: 1
menu_name: docsplatform_{{.version}}
section_menu_id: api
url: /docs/platform/{{.version}}/api/ace-upgrade/
aliases:
- /docs/platform/{{.version}}/api/ace-upgrade/overview/
---

# Platform Upgrade
Expand Down Expand Up @@ -48,11 +45,11 @@ Platform and per-cluster upgrades (FluxCD-driven).

## Pages

- [Platform Upgrade](../platform-upgrade.md) — the
- [Platform Upgrade](../platform-upgrade) — the
`/api/v1/upgrade*` endpoints: platform upgrade status, job status, history, and
current version, plus triggering a platform upgrade. Requires site-admin org
authorization.
- [Cluster Upgrade](../cluster-upgrade.md) — the
- [Cluster Upgrade](../cluster-upgrade) — the
`/api/v1/clusters/{owner}/{cluster}/upgrade*` and `.../spoke/upgrade*`
endpoints: imported-cluster and spoke-cluster upgrade status, history, current
and latest versions, plus triggering cluster/spoke upgrades. Gated by cluster
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-administration-readme
identifier: api-administration-overview
name: Overview
parent: api-administration
weight: 1
menu_name: docsplatform_{{.version}}
section_menu_id: api
url: /docs/platform/{{.version}}/api/administration/
aliases:
- /docs/platform/{{.version}}/api/administration/overview/
---

# Administration
Expand Down Expand Up @@ -85,6 +82,6 @@ Two admin surfaces: the legacy `/admin` group (administrative-org admins) and `/

## Pages

- [Administrative-Org Admin](../admin-org.md) — `/api/v1/admin/*`: manage users and their organizations.
- [Site Admin Console](../site-admin-console.md) — `/api/v1/accounts/admin/*`: dashboard, users, orgs, clusters, auth sources.
- [Site Settings](../site-settings.md) — `/allowed-domains`, `/disable-registration`, `/branding`.
- [Administrative-Org Admin](../admin-org) — `/api/v1/admin/*`: manage users and their organizations.
- [Site Admin Console](../site-admin-console) — `/api/v1/accounts/admin/*`: dashboard, users, orgs, clusters, auth sources.
- [Site Settings](../site-settings) — `/allowed-domains`, `/disable-registration`, `/branding`.
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-authorization-readme
identifier: api-authorization-overview
name: Overview
parent: api-authorization
weight: 1
menu_name: docsplatform_{{.version}}
section_menu_id: api
url: /docs/platform/{{.version}}/api/authorization/
aliases:
- /docs/platform/{{.version}}/api/authorization/overview/
---

# Authorization
Expand Down Expand Up @@ -40,6 +37,6 @@ Custom role management backed by the relationship-based authorization model.

## Pages

- [Roles & Permissions](../roles-permissions.md) — object
- [Roles & Permissions](../roles-permissions) — object
allowed-permissions lookups (single and batch), the available-permissions
catalog, role CRUD, and role principal listings.
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-billing-dashboard-readme
identifier: api-billing-dashboard-overview
name: Overview
parent: api-billing-dashboard
weight: 1
menu_name: docsplatform_{{.version}}
section_menu_id: api
url: /docs/platform/{{.version}}/api/billing-dashboard/
aliases:
- /docs/platform/{{.version}}/api/billing-dashboard/overview/
---

# Billing Dashboard
Expand Down Expand Up @@ -86,13 +83,13 @@ Available on billing-enabled deployments.

## Pages

- [Admin Billing Dashboard](../admin-dashboard.md) — the
- [Admin Billing Dashboard](../admin-dashboard) — the
site-admin `/api/v1/dashboard/*` routes: licensed users, their clusters,
per-cluster licenses and licensed products, resource/event histories, marketplace
subscriptions, and system-outage records.
- [User Billing Dashboard](../user-dashboard.md) — the
- [User Billing Dashboard](../user-dashboard) — the
owner-scoped `/api/v1/dashboard/clusters/*` routes (`view:contracts`): an
organization's own active clusters, licenses, licensed products, and event counts.
- [Usage Reports](../usage-reports.md) — the
- [Usage Reports](../usage-reports) — the
`/api/v1/dashboard/summary/*` monthly usage-report views and PDF download, plus
the `/api/v1/dbaas/billing/*` namespace billing reports.
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-chart-repositories-readme
identifier: api-chart-repositories-overview
name: Overview
parent: api-chart-repositories
weight: 1
menu_name: docsplatform_{{.version}}
section_menu_id: api
url: /docs/platform/{{.version}}/api/chart-repositories/
aliases:
- /docs/platform/{{.version}}/api/chart-repositories/overview/
---

# Chart Repositories
Expand All @@ -36,6 +33,6 @@ role is required. Only `GET` requests are exposed here.

## Pages

- [Chart Repositories](../chart-repositories.md) — list the
- [Chart Repositories](../chart-repositories) — list the
known chart repositories, list the charts inside a repository, and list the
versions of a named chart.
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-client-organizations-readme
identifier: api-client-organizations-overview
name: Overview
parent: api-client-organizations
weight: 1
menu_name: docsplatform_{{.version}}
section_menu_id: api
url: /docs/platform/{{.version}}/api/client-organizations/
aliases:
- /docs/platform/{{.version}}/api/client-organizations/overview/
---

# Client Organizations
Expand All @@ -22,11 +19,11 @@ user access on behalf of each client.

There are two concerns, split across two pages:

- [Client Org Management](../management.md) — site-admin
- [Client Org Management](../management) — site-admin
lifecycle of client organizations: list/get/create/delete client orgs, add or
remove clusters, and query client-org status. Routes live under
`/api/v1/user/client*`.
- [Cluster User Permissions](../cluster-user-permissions.md)
- [Cluster User Permissions](../cluster-user-permissions)
— organization-admin management of the OCM users belonging to a client org on
a specific cluster: list users, create a user with permissions, inspect and
update permissions, generate a kubeconfig, and remove a user. Routes live
Expand Down Expand Up @@ -56,5 +53,5 @@ For managed-service providers: site admins create "client orgs" and manage per-c

## Pages

- [Management](../management.md)
- [Cluster user permissions](../cluster-user-permissions.md)
- [Management](../management)
- [Cluster user permissions](../cluster-user-permissions)
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-cloud-providers-readme
identifier: api-cloud-providers-overview
name: Overview
parent: api-cloud-providers
weight: 1
menu_name: docsplatform_{{.version}}
section_menu_id: api
url: /docs/platform/{{.version}}/api/cloud-providers/
aliases:
- /docs/platform/{{.version}}/api/cloud-providers/overview/
---

# Cloud Providers
Expand Down Expand Up @@ -50,6 +47,6 @@ cloud credentials.

## Pages

- [Cloud Providers](../cloud-providers.md) — the public provider
- [Cloud Providers](../cloud-providers) — the public provider
list, CAPI cluster provisioning, and per-provider discovery for GKE, AKS, EKS,
DigitalOcean, Linode, Rancher, Hetzner, and KubeVirt.
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-cluster-management-v1-readme
identifier: api-cluster-management-v1-overview
name: Overview
parent: api-cluster-management-v1
weight: 1
menu_name: docsplatform_{{.version}}
section_menu_id: api
url: /docs/platform/{{.version}}/api/cluster-management-v1/
aliases:
- /docs/platform/{{.version}}/api/cluster-management-v1/overview/
---

# Cluster Management v1
Expand Down Expand Up @@ -99,15 +96,15 @@ Generic passthrough for any group/version/resource, powering the KubeDB Platform

## Pages

- [Cluster Lifecycle & Info](../lifecycle.md) — get, update, and
- [Cluster Lifecycle & Info](../lifecycle) — get, update, and
delete a cluster; fetch its kubeconfig; discover available resource types; database
status/bundle; feature values; execute whitelisted commands; create resources;
install/uninstall deploy orders; and read resource history.
- [Kubernetes Proxy](../kubernetes-proxy.md) — the generic
- [Kubernetes Proxy](../kubernetes-proxy) — the generic
`/proxy/*` passthrough for any Kubernetes group/version/resource (CRUD, status,
events, controller, scale, HPAs), plus pod logs/exec, node/pod metrics, access
reviews, the `meta.k8s.appscode.com` render endpoints, scanner/policy reports, and
batch delete.
- [Helm](../helm.md) — Helm console (tiller) configuration, Helm
- [Helm](../helm) — Helm console (tiller) configuration, Helm
v3 release management (list/install/upgrade/uninstall/rollback, content, status,
history), bundle/package views, and the resource editor.
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-cluster-management-v2-readme
identifier: api-cluster-management-v2-overview
name: Overview
parent: api-cluster-management-v2
weight: 1
menu_name: docsplatform_{{.version}}
section_menu_id: api
url: /docs/platform/{{.version}}/api/cluster-management-v2/
aliases:
- /docs/platform/{{.version}}/api/cluster-management-v2/overview/
---

# Cluster Management v2
Expand Down Expand Up @@ -71,8 +68,8 @@ Related: `GET /api/v1/agent/:clusterName/:clusterID/token` (Token) — inbox age

## Pages

- [Clusters](../clusters.md) — providers, hubs, cluster identity,
- [Clusters](../clusters) — providers, hubs, cluster identity,
listing, status, import/connect/remove, reconcile, reconfigure, Kubernetes version
upgrades, gateway configs, feature conversion, and vclusters.
- [Subscriptions & Inbox](../subscriptions.md) — cluster,
- [Subscriptions & Inbox](../subscriptions) — cluster,
namespace, and resource notification subscriptions, plus the inbox agent token.
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-licensing-contracts-readme
identifier: api-licensing-contracts-overview
name: Overview
parent: api-licensing-contracts
weight: 1
menu_name: docsplatform_{{.version}}
section_menu_id: api
url: /docs/platform/{{.version}}/api/licensing-contracts/
aliases:
- /docs/platform/{{.version}}/api/licensing-contracts/overview/
---

# Licensing & Contracts
Expand Down Expand Up @@ -79,11 +76,11 @@ Related: `POST /api/v1/user/license-proxy` — generate the `license-proxyserver

## Pages

- [License Registration](../registration.md) — `POST /register`,
- [License Registration](../registration) — `POST /register`,
`POST /license/issue`, `POST /user/license-proxy`.
- [Contracts — Admin](../contracts-admin.md) — `/contracts/*`
- [Contracts — Admin](../contracts-admin) — `/contracts/*`
(AppsCode-hosted, site-admin).
- [Contracts — User](../contracts-user.md) — `/user/contracts/*`
- [Contracts — User](../contracts-user) — `/user/contracts/*`
(AppsCode-hosted, token).

## Common concepts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
layout: docs
menu:
docsplatform_{{.version}}:
identifier: api-marketplace-readme
identifier: api-marketplace-overview
name: Overview
parent: api-marketplace
weight: 1
menu_name: docsplatform_{{.version}}
section_menu_id: api
url: /docs/platform/{{.version}}/api/marketplace/
aliases:
- /docs/platform/{{.version}}/api/marketplace/overview/
---

# Marketplace
Expand Down Expand Up @@ -56,5 +53,5 @@ GET endpoints, the observed behaviour on a non-marketplace deployment.

## Pages

- [Webhook Service](../webhook-service.md) — `/marketplace/api/v1/*`: claimable check, AWS/Azure/GCP subscription notifications, and version (separate listener).
- [Metered Billing](../metered-billing.md) — `/api/v1/proxy/metered-billing/marketplaces/*`: AWS/GCP usage reporting and readiness probes (site-admin, deployment-gated).
- [Webhook Service](../webhook-service) — `/marketplace/api/v1/*`: claimable check, AWS/Azure/GCP subscription notifications, and version (separate listener).
- [Metered Billing](../metered-billing) — `/api/v1/proxy/metered-billing/marketplaces/*`: AWS/GCP usage reporting and readiness probes (site-admin, deployment-gated).
Loading
Loading