Backstage · JSON Structure

Catalog Entity Structure

A Backstage catalog entity.

Type: object Properties: 6 Required: 3
Developer PortalInternal Developer PlatformSoftware CatalogOpen Source

Entity is a JSON Structure definition published by Backstage, describing 6 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

apiVersion kind metadata spec relations status

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/json-structure/catalog-entity-structure.json",
  "name": "Entity",
  "description": "A Backstage catalog entity.",
  "type": "object",
  "properties": {
    "apiVersion": {
      "type": "string",
      "description": "The API version of the entity schema.",
      "example": "backstage.io/v1alpha1"
    },
    "kind": {
      "type": "string",
      "description": "The kind of entity. Common kinds include Component, API, System, Domain, Resource, Group, User, Location, and Template.",
      "example": "Component"
    },
    "metadata": {
      "$ref": "#/components/schemas/EntityMetadata"
    },
    "spec": {
      "type": "object",
      "description": "The specification of the entity. The schema varies depending on the kind and type.",
      "additionalProperties": true
    },
    "relations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityRelation"
      }
    },
    "status": {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string"
              },
              "level": {
                "type": "string",
                "enum": [
                  "info",
                  "warning",
                  "error"
                ]
              },
              "message": {
                "type": "string"
              },
              "error": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  },
  "required": [
    "apiVersion",
    "kind",
    "metadata"
  ]
}