ConfigHub · Schema

UploadRequest

CompanyConfigurationDevOpsKubernetesGitOpsPlatform

Properties

Name Type Description
ChangeDescription string Recorded on each Unit write.
ChangeSetDescription string
ChangeSetID string An existing ChangeSet to record the writes in. Default: one new ChangeSet per Space. The upload closes it afterwards, unless a ChangeWorkflow governs it.
ChangeWorkflowID string The ChangeWorkflow governing the ChangeSet the upload opens, which a Space whose Component requires one needs. A ChangeSet a ChangeWorkflow governs is left open, with the Units the upload wrote in it,
Clearance object The guarded reasons the Unit writes are cleared for. A path whose guards this does not cover is not written, and the withheld change is reported in the Unit's Conflicts.
Components array Placement of each component. Exactly one is supported.
DryRun boolean Plan the upload and return the same response without writing anything.
Files array The bundle's files. Paths must be relative and may not contain "..". Exactly one of Files and Source.Pull is given.
Partial boolean The bundle is part of what its source owns: Units the source owns that it leaves out are left alone rather than emptied.
Source object
SpaceLabels object Labels applied to every Space, merge-patch: keys given are set, keys omitted are left alone.
SpacePattern string Slug pattern for created Spaces, over the Space's Component and labels. Default {{.Component.Slug}}-{{.Labels.Variant}}.
Subgroup string A category recorded on the Mutations of each Unit write. Alphanumeric, at most 64 characters, and not starting with ConfigHub.
TagID string A Tag to put on the Revision each Unit the upload writes is left at, created Units included. Units the upload leaves Unchanged are not tagged. Requires Use permission on the Tag; a ChangeSet's or Chan
View JSON Schema on GitHub

JSON Schema

confighub-upload-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/confighub/json-schema/confighub-upload-request-schema.json",
  "title": "UploadRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/confighub-upload-api-openapi.yml#/components/schemas/UploadRequest",
  "type": "object",
  "properties": {
    "ChangeDescription": {
      "type": "string",
      "description": "Recorded on each Unit write.",
      "x-go-type-skip-optional-pointer": true
    },
    "ChangeSetDescription": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "ChangeSetID": {
      "type": "string",
      "description": "An existing ChangeSet to record the writes in. Default: one new ChangeSet per Space. The upload closes it afterwards, unless a ChangeWorkflow governs it.",
      "format": "uuid"
    },
    "ChangeWorkflowID": {
      "type": "string",
      "description": "The ChangeWorkflow governing the ChangeSet the upload opens, which a Space whose Component requires one needs. A ChangeSet a ChangeWorkflow governs is left open, with the Units the upload wrote in it, since closing it is gated on the workflow's Final prerequisites. Not accepted with ChangeSetID, whose ChangeSet names its own.",
      "format": "uuid"
    },
    "Clearance": {
      "allOf": [
        {
          "$ref": "#/$defs/Clearance"
        }
      ],
      "description": "The guarded reasons the Unit writes are cleared for. A path whose guards this does not cover is not written, and the withheld change is reported in the Unit's Conflicts."
    },
    "Components": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/UploadComponentRequest"
      },
      "description": "Placement of each component. Exactly one is supported.",
      "x-go-type-skip-optional-pointer": true
    },
    "DryRun": {
      "type": "boolean",
      "description": "Plan the upload and return the same response without writing anything.",
      "x-go-type-skip-optional-pointer": true
    },
    "Files": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/UploadRequestFile"
      },
      "description": "The bundle's files. Paths must be relative and may not contain \"..\". Exactly one of Files and Source.Pull is given.",
      "x-go-type-skip-optional-pointer": true
    },
    "Partial": {
      "type": "boolean",
      "description": "The bundle is part of what its source owns: Units the source owns that it leaves out are left alone rather than emptied.",
      "x-go-type-skip-optional-pointer": true
    },
    "Source": {
      "$ref": "#/$defs/UploadSourceInfo"
    },
    "SpaceLabels": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Labels applied to every Space, merge-patch: keys given are set, keys omitted are left alone.",
      "x-go-type-skip-optional-pointer": true
    },
    "SpacePattern": {
      "type": "string",
      "description": "Slug pattern for created Spaces, over the Space's Component and labels. Default {{.Component.Slug}}-{{.Labels.Variant}}.",
      "x-go-type-skip-optional-pointer": true
    },
    "Subgroup": {
      "type": "string",
      "description": "A category recorded on the Mutations of each Unit write. Alphanumeric, at most 64 characters, and not starting with ConfigHub.",
      "x-go-type-skip-optional-pointer": true
    },
    "TagID": {
      "type": "string",
      "description": "A Tag to put on the Revision each Unit the upload writes is left at, created Units included. Units the upload leaves Unchanged are not tagged. Requires Use permission on the Tag; a ChangeSet's or ChangeOrder's own Tag is refused. An upload with a Unit to write that the Tag already marks fails, and nothing is written.",
      "format": "uuid"
    }
  },
  "$defs": {
    "Clearance": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ClearanceRequirement"
      }
    },
    "ClearanceRequirement": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "The guard key this requirement is about",
          "x-go-type-skip-optional-pointer": true
        },
        "Operator": {
          "type": "string",
          "description": "Exists, In, NotIn, or DoesNotExist",
          "x-go-type-skip-optional-pointer": true
        },
        "Values": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The values In and NotIn compare against; unused by Exists and DoesNotExist",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "UploadComponentRequest": {
      "type": "object",
      "properties": {
        "Adopt": {
          "type": "boolean",
          "description": "Take over the backing Unit of an entity a document describes when another source owns it. Without it, that document is refused.",
          "x-go-type-skip-optional-pointer": true
        },
        "BackingUnitSpace": {
          "type": "string",
          "description": "The Space, by slug, for the backing Units of the bundle's Space and Component documents; it may be the component's own Space. Required when the bundle has either.",
          "x-go-type-skip-optional-pointer": true
        },
        "CreateNamespace": {
          "type": "boolean",
          "description": "Synthesize the release Namespace if the bundle lacks it and it is not one every cluster has (default, kube-node-lease, kube-public, kube-system). Off by default.",
          "x-go-type-skip-optional-pointer": true
        },
        "DependsOn": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Names of the components this one depends on, recorded by ComponentID in the Space's DependsOn annotation. Each Component must already exist. Requires a Variant Space label.",
          "x-go-type-skip-optional-pointer": true
        },
        "Name": {
          "type": "string",
          "description": "The component name. Without one, Space must name an existing Space, which is written into as it is, with no Component and no labels set, and SourceName is required.",
          "x-go-type-skip-optional-pointer": true
        },
        "Namespace": {
          "type": "string",
          "description": "The release namespace. Required when the bundle has namespaced resources that name no namespace.",
          "x-go-type-skip-optional-pointer": true
        },
        "SlugPrefix": {
          "type": "string",
          "description": "Prepended to the slugs of new Units, so two releases can share one Space.",
          "x-go-type-skip-optional-pointer": true
        },
        "SourceName": {
          "type": "string",
          "description": "Ownership name within the component's Spaces. Default: Name.",
          "x-go-type-skip-optional-pointer": true
        },
        "Space": {
          "type": "string",
          "description": "Explicit Space slug, overriding SpacePattern.",
          "x-go-type-skip-optional-pointer": true
        },
        "SpaceAnnotations": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "x-go-type-skip-optional-pointer": true
        },
        "SpaceDeleteGates": {
          "type": "object",
          "additionalProperties": {
            "type": "boolean"
          },
          "description": "Set on Spaces the upload creates.",
          "x-go-type-skip-optional-pointer": true
        },
        "SpaceLabels": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Merged over UploadRequest.SpaceLabels.",
          "x-go-type-skip-optional-pointer": true
        },
        "TargetID": {
          "type": "string",
          "description": "Applies to the component's Spaces. New Units are created on it, except AppConfig Units.",
          "format": "uuid"
        },
        "UnitAnnotations": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "x-go-type-skip-optional-pointer": true
        },
        "UnitDeleteGates": {
          "type": "object",
          "additionalProperties": {
            "type": "boolean"
          },
          "description": "Set on Units the upload creates.",
          "x-go-type-skip-optional-pointer": true
        },
        "UnitDestroyGates": {
          "type": "object",
          "additionalProperties": {
            "type": "boolean"
          },
          "description": "Set on Units the upload creates.",
          "x-go-type-skip-optional-pointer": true
        },
        "UnitLabels": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Set on every Unit the source writes.",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "UploadRegistryCredentials": {
      "type": "object",
      "properties": {
        "Password": {
          "type": "string",
          "description": "The password, or an access token for registries that issue them.",
          "x-go-type-skip-optional-pointer": true
        },
        "Username": {
          "type": "string",
          "description": "The registry username.",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "UploadRequestFile": {
      "type": "object",
      "properties": {
        "Content": {
          "type": "string",
          "description": "The file's contents.",
          "x-go-type-skip-optional-pointer": true
        },
        "Path": {
          "type": "string",
          "description": "Relative path within the bundle, e.g. backend.yaml.",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "UploadSourceInfo": {
      "type": "object",
      "properties": {
        "Client": {
          "type": "string",
          "description": "The client that uploaded: cub, installer, ui.",
          "x-go-type-skip-optional-pointer": true
        },
        "ClientVersion": {
          "type": "string",
          "x-go-type-skip-optional-pointer": true
        },
        "Credentials": {
          "allOf": [
            {
              "$ref": "#/$defs/UploadRegistryCredentials"
            }
          ],
          "description": "Registry credentials for the pull. Used for this request only; never stored, logged, or returned."
        },
        "Digest": {
          "type": "string",
          "description": "The resolved digest, when the transport has one.",
          "x-go-type-skip-optional-pointer": true
        },
        "Pull": {
          "type": "boolean",
          "description": "Fetch the bundle from Ref, an oci:// reference, instead of taking Files. With Digest set, that manifest is fetched rather than whatever Ref's tag names now.",
          "x-go-type-skip-optional-pointer": true
        },
        "Ref": {
          "type": "string",
          "description": "Where the bundle came from, e.g. oci://ghcr.io/confighub/configs/cubbychat:1.4.0 or a local path.",
          "x-go-type-skip-optional-pointer": true
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/confighub-upload-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.