Upbound · Schema

Upbound Control Plane

A managed Crossplane control plane on the Upbound platform

Cloud InfrastructureCrossplaneDeveloper ExperienceInternal Developer PlatformPlatform Engineering

Properties

Name Type Description
id string Unique control plane identifier
name string Control plane name (slug)
description string Human-readable description
organizationName string Parent organization name
configuration string Crossplane configuration package reference (e.g. xpkg.upbound.io/upbound/platform-ref-aws:v0.9.0)
status string Current control plane status
region string Hosting region
crossplaneVersion string Crossplane version running on this control plane
kubeconfig string Base64-encoded kubeconfig for direct API access
createdAt string
updatedAt string
View JSON Schema on GitHub

JSON Schema

upbound-control-plane-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upbound/main/json-schema/upbound-control-plane-schema.json",
  "title": "Upbound Control Plane",
  "description": "A managed Crossplane control plane on the Upbound platform",
  "type": "object",
  "required": ["id", "name", "organizationName", "configuration", "status"],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique control plane identifier"
    },
    "name": {
      "type": "string",
      "description": "Control plane name (slug)"
    },
    "description": {
      "type": "string",
      "description": "Human-readable description"
    },
    "organizationName": {
      "type": "string",
      "description": "Parent organization name"
    },
    "configuration": {
      "type": "string",
      "description": "Crossplane configuration package reference (e.g. xpkg.upbound.io/upbound/platform-ref-aws:v0.9.0)"
    },
    "status": {
      "type": "string",
      "enum": ["provisioning", "ready", "updating", "deleting", "error"],
      "description": "Current control plane status"
    },
    "region": {
      "type": "string",
      "description": "Hosting region"
    },
    "crossplaneVersion": {
      "type": "string",
      "description": "Crossplane version running on this control plane"
    },
    "kubeconfig": {
      "type": "string",
      "description": "Base64-encoded kubeconfig for direct API access"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}