API Reference

Discovery

Unauthenticated OpenAPI spec and Swagger UI endpoints for the Kubeadapt /v1 API.

Three unauthenticated endpoints publish the API contract and an interactive UI: the OpenAPI 3.1 document in JSON, the same document in YAML, and an embedded Swagger UI.

Authentication

All three endpoints are unauthenticated. The Authorization: Bearer header is not required and is not validated.

Response shape

These endpoints do not use the universal {data, meta, error} envelope.

/v1/openapi.json and /v1/openapi.yaml return the OpenAPI 3.1 document directly.
/v1/docs returns HTML.

See API Overview for the envelope contract used on every other route.

OpenAPI spec (JSON)

GET /v1/openapi.json

Required scope: none, unauthenticated.

Returns the OpenAPI 3.1 document for the /v1 API. The document is the authoritative specification for the API contract and is the input for SDK generators (openapi-generator, oapi-codegen, swagger-codegen).

Example request

bash

curl "https://public-api.kubeadapt.io/v1/openapi.json"

Example response

json

1{
2  "openapi": "3.1.0",
3  "info": {
4    "title": "Kubeadapt API",
5    "version": "v1"
6  },
7  "servers": [
8    { "url": "https://public-api.kubeadapt.io", "description": "Production" }
9  ],
10  "paths": { "...": "..." },
11  "components": { "...": "..." }
12}

Common errors

HTTP	When
404	The OpenAPI surface is disabled on this deployment.

OpenAPI spec (YAML)

GET /v1/openapi.yaml

Required scope: none, unauthenticated.

Identical content to /v1/openapi.json, YAML-encoded.

Example request

bash

curl "https://public-api.kubeadapt.io/v1/openapi.yaml"

Example response

yaml

1openapi: 3.1.0
2info:
3  title: Kubeadapt API
4  version: v1
5servers:
6  - url: https://public-api.kubeadapt.io
7    description: Production
8paths:
9  # ...
10components:
11  # ...

Common errors

HTTP	When
404	The OpenAPI surface is disabled on this deployment.

Swagger UI

GET /v1/docs

Required scope: none, unauthenticated.

The embedded Swagger UI, served as an HTML page. The page loads /v1/openapi.json by default and renders the spec's servers block as a dropdown. The ?url=<spec-url> query parameter overrides the default spec URL.

Example request

Open in a browser:

plaintext

https://public-api.kubeadapt.io/v1/docs

Or fetch the HTML:

bash

curl "https://public-api.kubeadapt.io/v1/docs"

Example response

html

1<!DOCTYPE html>
2<html lang="en">
3<head>
4  <meta charset="UTF-8">
5  <title>Kubeadapt API v1: Swagger UI</title>
6  ...
7</head>
8<body>
9  <div id="swagger-ui"></div>
10  ...
11</body>
12</html>

Common errors

HTTP	When
404	The docs surface is disabled on this deployment.

Discovery

Unauthenticated OpenAPI spec and Swagger UI endpoints for the Kubeadapt /v1 API.

Three unauthenticated endpoints publish the API contract and an interactive UI: the OpenAPI 3.1 document in JSON, the same document in YAML, and an embedded Swagger UI.

Authentication

All three endpoints are unauthenticated. The Authorization: Bearer header is not required and is not validated.

Response shape

These endpoints do not use the universal {data, meta, error} envelope.

/v1/openapi.json and /v1/openapi.yaml return the OpenAPI 3.1 document directly.
/v1/docs returns HTML.

See API Overview for the envelope contract used on every other route.

OpenAPI spec (JSON)

GET /v1/openapi.json

Required scope: none, unauthenticated.

Example request

bash

curl "https://public-api.kubeadapt.io/v1/openapi.json"

Example response

json

1{
2  "openapi": "3.1.0",
3  "info": {
4    "title": "Kubeadapt API",
5    "version": "v1"
6  },
7  "servers": [
8    { "url": "https://public-api.kubeadapt.io", "description": "Production" }
9  ],
10  "paths": { "...": "..." },
11  "components": { "...": "..." }
12}

Common errors

HTTP	When
404	The OpenAPI surface is disabled on this deployment.

OpenAPI spec (YAML)

GET /v1/openapi.yaml

Required scope: none, unauthenticated.

Identical content to /v1/openapi.json, YAML-encoded.

Example request

bash

curl "https://public-api.kubeadapt.io/v1/openapi.yaml"

Example response

yaml

1openapi: 3.1.0
2info:
3  title: Kubeadapt API
4  version: v1
5servers:
6  - url: https://public-api.kubeadapt.io
7    description: Production
8paths:
9  # ...
10components:
11  # ...

Common errors

HTTP	When
404	The OpenAPI surface is disabled on this deployment.

Swagger UI

GET /v1/docs

Required scope: none, unauthenticated.

Example request

Open in a browser:

plaintext

https://public-api.kubeadapt.io/v1/docs

Or fetch the HTML:

bash

curl "https://public-api.kubeadapt.io/v1/docs"

Example response

html

1<!DOCTYPE html>
2<html lang="en">
3<head>
4  <meta charset="UTF-8">
5  <title>Kubeadapt API v1: Swagger UI</title>
6  ...
7</head>
8<body>
9  <div id="swagger-ui"></div>
10  ...
11</body>
12</html>

Common errors

HTTP	When
404	The docs surface is disabled on this deployment.

Discovery

Authentication

Response shape

OpenAPI spec (JSON)

Example request

Example response

Common errors

OpenAPI spec (YAML)

Example request

Example response

Common errors

Swagger UI

Example request

Example response

Common errors

See also

Related

Discovery

Authentication

Response shape

OpenAPI spec (JSON)

Example request

Example response

Common errors

OpenAPI spec (YAML)

Example request

Example response

Common errors

Swagger UI

Example request

Example response

Common errors

See also

Related