ConfigHub · Schema
ComponentCreateOrUpdateResponse
CompanyConfigurationDevOpsKubernetesGitOpsPlatform
Properties
| Name | Type | Description |
|---|---|---|
| Component | object | |
| Error | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/confighub/json-schema/confighub-component-create-or-update-response-schema.json",
"title": "ComponentCreateOrUpdateResponse",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/confighub-component-api-openapi.yml#/components/schemas/ComponentCreateOrUpdateResponse",
"type": "object",
"properties": {
"Component": {
"$ref": "#/$defs/Component"
},
"Error": {
"$ref": "#/$defs/ResponseError"
}
},
"$defs": {
"Component": {
"required": [
"Slug"
],
"type": "object",
"properties": {
"AllowedChangeWorkflowIDs": {
"type": "array",
"items": {
"$ref": "#/$defs/UUID"
},
"description": "The set of ChangeWorkflows that can be used for promotions and releases of this component's Variants, and for ChangeSets opened on their Units: a ChangeOrder or ChangeSet is governed by one workflow, which every component it reaches has to allow. Changing it requires Manage permission on the component. (optional)",
"x-confighub-where": {
"dataType": "[]uuid",
"references": "ChangeWorkflow"
},
"x-go-type-skip-optional-pointer": true
},
"Annotations": {
"type": "object",
"additionalProperties": {
"maxLength": 1024,
"pattern": "^(.|\\n)*$",
"type": "string"
},
"description": "An optional map of Annotation key/value pairs for tools to attach information to entities.",
"x-confighub-where": {
"dataType": "map[string]string"
},
"x-go-type-skip-optional-pointer": true
},
"BackingUnitID": {
"type": "string",
"format": "uuid",
"readOnly": true,
"x-confighub-where": {
"dataType": "uuid",
"references": "Unit"
}
},
"ChangeWorkflowRequired": {
"type": "boolean",
"description": "Whether a ChangeWorkflow must be used for promotions and releases of this component's Variants, and by ChangeSets opened on their Units. Changing it requires Manage permission on the component. (optional)",
"x-confighub-where": {
"dataType": "bool"
},
"x-go-type-skip-optional-pointer": true
},
"ComponentID": {
"type": "string",
"description": "Unique identifier for a component.",
"format": "uuid",
"x-confighub-where": {
"dataType": "uuid"
},
"x-go-type-skip-optional-pointer": true,
"x-omitzero": true
},
"CreatedAt": {
"type": "string",
"description": "The timestamp when the entity was created in \"2023-01-01T12:00:00Z\" format.",
"format": "date-time",
"readOnly": true,
"x-confighub-where": {
"dataType": "time"
},
"x-go-type-skip-optional-pointer": true,
"x-omitzero": true
},
"DeleteGates": {
"type": "object",
"additionalProperties": {
"type": "boolean"
},
"description": "An optional set of gates that, if any is present, will block deletion.",
"x-confighub-where": {
"dataType": "map[string]bool"
},
"x-go-type-skip-optional-pointer": true
},
"DisplayName": {
"type": "string",
"description": "Friendly name for the entity.",
"x-confighub-where": {
"dataType": "string"
},
"x-go-type-skip-optional-pointer": true
},
"EntityType": {
"type": "string",
"description": "The type of entity.",
"readOnly": true,
"x-go-type-skip-optional-pointer": true
},
"HiddenReason": {
"maxLength": 64,
"pattern": "^([A-Za-z0-9]([\\-_.A-Za-z0-9]*[A-Za-z0-9])?)?$",
"type": "string",
"description": "The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another.",
"x-confighub-where": {
"dataType": "string"
},
"x-go-type-skip-optional-pointer": true
},
"Labels": {
"type": "object",
"additionalProperties": {
"maxLength": 128,
"pattern": "^[\\-_@/#$%&~+=!?.,:;(){}\\[\\]<>|A-Za-z0-9](([\\-_@/#$%&~+=!?.,:;(){}\\[\\]<>|A-Za-z0-9]| )*[\\-_@/#$%&~+=!?.,:;(){}\\[\\]<>|A-Za-z0-9])?$",
"type": "string"
},
"description": "An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them.",
"x-confighub-where": {
"dataType": "map[string]string"
},
"x-go-type-skip-optional-pointer": true
},
"OrganizationID": {
"type": "string",
"description": "Unique identifier for an organization.",
"format": "uuid",
"x-confighub-where": {
"dataType": "uuid",
"references": "Organization",
"expandable": true
},
"x-go-type-skip-optional-pointer": true,
"x-omitzero": true
},
"Permissions": {
"allOf": [
{
"$ref": "#/$defs/Permissions"
}
],
"description": "Permissions to access this component.",
"x-confighub-where": {
"dataType": "map[string]map[string]map[uuid]bool"
}
},
"Slug": {
"maxLength": 128,
"pattern": "^[A-Za-z0-9]([\\-_.A-Za-z0-9]*[A-Za-z0-9])?$",
"type": "string",
"description": "Unique URL-safe identifier for the entity.",
"x-confighub-where": {
"dataType": "string"
},
"x-go-type-skip-optional-pointer": true
},
"UpdatedAt": {
"type": "string",
"description": "The timestamp when the entity was last updated in \"2023-01-01T12:00:00Z\" format.",
"format": "date-time",
"readOnly": true,
"x-confighub-where": {
"dataType": "time"
},
"x-go-type-skip-optional-pointer": true,
"x-omitzero": true
},
"UpstreamComponentID": {
"type": "string",
"format": "uuid",
"readOnly": true,
"x-confighub-where": {
"dataType": "uuid",
"references": "Component"
}
},
"Version": {
"type": "integer",
"description": "An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.",
"format": "int64",
"readOnly": false,
"x-go-type-skip-optional-pointer": true
}
},
"description": "The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, and whether one is required."
},
"ErrorItem": {
"type": "object",
"properties": {
"Description": {
"type": "string",
"description": "A clear explanation of what went wrong",
"x-go-type-skip-optional-pointer": true
},
"Item": {
"type": "string",
"description": "The name of the field, resource, or entity that the error relates to",
"x-go-type-skip-optional-pointer": true
}
}
},
"ErrorMetadata": {
"type": "object",
"properties": {
"EntityID": {
"type": "string",
"description": "Optional ID of the entity this error relates to",
"x-go-type-skip-optional-pointer": true
},
"EntitySlug": {
"type": "string",
"description": "Optional slug of the entity this error relates to",
"x-go-type-skip-optional-pointer": true
},
"EntityType": {
"type": "string",
"description": "Optional type of the entity this error relates to",
"x-go-type-skip-optional-pointer": true
},
"Items": {
"type": "array",
"items": {
"$ref": "#/$defs/ErrorItem"
},
"description": "Collection of error details",
"x-go-type-skip-optional-pointer": true
}
}
},
"Permissions": {
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/Subjects"
}
},
"ResponseError": {
"type": "object",
"properties": {
"Details": {
"type": "array",
"items": {
"type": "string"
},
"description": "Additional context messages",
"x-go-type-skip-optional-pointer": true
},
"ErrorMetadata": {
"allOf": [
{
"$ref": "#/$defs/ErrorMetadata"
}
],
"description": "Structured error details like field violations"
},
"Message": {
"type": "string",
"description": "The primary error message",
"x-go-type-skip-optional-pointer": true
},
"Status": {
"type": "integer",
"description": "HTTP status code",
"x-go-type-skip-optional-pointer": true
},
"Type": {
"type": "string",
"description": "The category of the error, as a code: UserInput, Validation, Data, Authentication, Permission, NotFound, Conflict, AlreadyExists, Unprocessable, Locked, PreconditionFailed, TooManyRequests, Unexpected, GatewayTimeout, or ServiceUnavailable",
"x-go-type-skip-optional-pointer": true
}
}
},
"Subjects": {
"type": "object",
"properties": {
"GroupIDs": {
"type": "object",
"additionalProperties": {
"type": "boolean"
},
"x-go-type-skip-optional-pointer": true
},
"UserIDs": {
"type": "object",
"additionalProperties": {
"type": "boolean"
},
"x-go-type-skip-optional-pointer": true
}
}
},
"UUID": {
"type": "string",
"format": "uuid"
}
}
}
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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/confighub-component-create-or-update-response"
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.