How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kubernetes Operators Custom Resource Definitions API

CustomResourceDefinition resources that extend the Kubernetes API with new resource types, schemas, and versioning for operator-managed objects.

This API exposes 6 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version v1.32.0.

Requests are made against a single base URL, https://kubernetes.default.svc.

6 operations 2 paths 12 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1.32.0
Server
https://kubernetes.default.svc
Authentication
HTTP Bearer, Mutual TLS
Terms of Service
Resource Areas
1

Authentication & Security 2

Kubernetes Operators Custom Resource Definitions API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It requires mutual TLS (clientCertificate). By default, every request must be authenticated.

  • bearerAuth — Kubernetes service account or user bearer token.
  • clientCertificate — Client TLS certificate signed by the cluster CA.

Paths & Operations 6

Across 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

CustomResourceDefinitions 6

CustomResourceDefinition resources that extend the Kubernetes API with new resource types, schemas, and versioning for operator-managed objects.

GET
/apis/apiextensions.k8s.io/v1/customresourcedefinitions
List CustomResourceDefinitions
listCustomResourceDefinitions 6 params → 200401
POST
/apis/apiextensions.k8s.io/v1/customresourcedefinitions
Create a CustomResourceDefinition
createCustomResourceDefinition 1 param body → 201400401409
GET
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
Get a CustomResourceDefinition
getCustomResourceDefinition 1 param → 200401404
PUT
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
Replace a CustomResourceDefinition
replaceCustomResourceDefinition 2 params body → 200400401404
PATCH
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
Patch a CustomResourceDefinition
patchCustomResourceDefinition 1 param body → 200401404
DELETE
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
Delete a CustomResourceDefinition
deleteCustomResourceDefinition 1 param → 200401404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are CustomResourceDefinitionVersion (8 properties), ObjectMeta (7 properties), CustomResourceColumnDefinition (6 properties), CustomResourceDefinitionNames (6 properties). Each schema is shown below with its type and property counts.

ListMeta
object
Metadata for list responses.
3 properties
CustomResourceColumnDefinition
object
A column definition for kubectl get output, displaying a field from the custom resource using a JSON path expression.
6 properties 3 required
CustomResourceDefinition
object
A CustomResourceDefinition registers a new API resource type with the Kubernetes API server. Once established, users can create, list, and watch instances of t…
5 properties
CustomResourceDefinitionStatus
object
Status of a CustomResourceDefinition reporting whether the API has been established, names have been accepted, and which versions are stored.
3 properties
CustomResourceValidation
object
OpenAPI v3 schema used to validate custom resource instances on creation and update. Applied per-version or at the CRD level.
1 property
CustomResourceDefinitionList
object
A list of CustomResourceDefinitions.
4 properties 1 required
CustomResourceDefinitionNames
object
Naming configuration for the custom resource type including the kind, plural REST path segment, and optional short names for kubectl.
6 properties 2 required
CustomResourceDefinitionSpec
object
Specification for the custom resource type including the API group, kind names, resource scope, supported versions, and validation schemas.
5 properties 4 required
ObjectMeta
object
Standard Kubernetes object metadata.
7 properties
CRDCondition
object
A condition on a CustomResourceDefinition indicating the status of a specific aspect such as name acceptance or API establishment.
5 properties 2 required
Status
object
Error or result status.
4 properties
CustomResourceDefinitionVersion
object
A single version of the custom resource API. Multiple versions may be served simultaneously; exactly one version must be the storage version.
8 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubernetes-operators-customresourcedefinitions-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Kubernetes Operators Custom Resource Definitions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.