Skip to main content

Entity types

Every entity in the catalog is associated with an entity type. Each definition requires a type and a JSON schema that outlines the spec any resource of that type should conform to.

Each entity of a custom type will have its x-cortex-definition validated against its schema.

JSON schema for custom entity type

The definitions for these custom entity types are powered by the open source JSON Schema project. While JSON Schema provides many different capabilities, it is typical to keep things simple.

"required": [
"properties": {
"version": {
"type": "string"
"distribution": {
"type": "string"

Acceptable type are array, boolean, integer, null, number, object, and string.


You can create, update, and delete entity types using the Cortex API.