ServiceEntrySchema

The ServiceEntrySchema represents the configuration and status of a service in the ConfidentialMind system.

Properties

Property	Type	Description
id	string	Unique identifier for the service
type	ServiceType	The type of the service
deployment_state	DeploymentState	Current deployment state of the service
display_name	string | null	Optional display name for the service
metadata	MetadataSchema | null	Optional metadata for the service
config	object | null	Optional configuration object for the service
config_schema	object | null	Optional schema for the configuration
connectors	ConnectorsConfig | null	Optional connectors configuration

Secret fields

When you read a service, the API hides secret values. It returns *** in their place. This applies to every caller, including service admins.

These fields are hidden wherever they appear in config or metadata:

• api_key
• aws_access_key_id
• aws_secret_access_key
• project_id
• s3_access_key
• s3_secret_key
• azure_connection_string
• redcap_api_token

The values of environment variables are hidden in the same way. See ServiceOverrideSchema.

To keep a stored secret when you update a service, send *** back unchanged in the PATCH request. The API keeps the value it already has. To change a secret, send the new value instead.

Enums

ServiceType

• playground
• api
• model
• external_llm
• database
• bucket
• external_database
• frontend

DeploymentState

• not_deployed
• starting
• stopping
• deployed
• error

Related Schemas

• MetadataSchema (used in the metadata field)
• ServiceOverrideSchema (used in the metadata.overwrite_values field)
• ResourceUserSchema (used in user management endpoints)

Example

{
  "id": "service-123",
  "type": "api",
  "deployment_state": "deployed",
  "display_name": "My API Service",
  "metadata": {
    "deployment_image": "myimage",
    "deployment_image_version": "1.0.0",
    "chart_version": "0.1.0",
    "overwrite_values": {
      "replicaCount": 3
    }
  },
  "config": {
    "api_key": "***"
  },
  "config_schema": {
    "type": "object",
    "properties": {
      "api_key": { "type": "string" }
    }
  },
  "connectors": {
    "connectors": [
      {
        "type": "database",
        "label": "Main Database",
        "config_id": "db-001",
        "stack_id": null
      }
    ]
  }
}

This schema is used in various endpoints of the ConfidentialMind Manager API, including GET, POST, and PATCH operations on services.