CockroachDB · Schema

Error

Standard error response returned by the API.

Cluster ManagementCloudDatabaseDistributed SQLInfrastructurePostgreSQL CompatibleSQL

Properties

Name Type Description
code integer HTTP status code of the error.
message string Human-readable description of the error.
details array Additional detail objects providing error context.
View JSON Schema on GitHub

JSON Schema

cockroachdb-error-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Error",
  "title": "Error",
  "type": "object",
  "description": "Standard error response returned by the API.",
  "properties": {
    "code": {
      "type": "integer",
      "description": "HTTP status code of the error."
    },
    "message": {
      "type": "string",
      "description": "Human-readable description of the error."
    },
    "details": {
      "type": "array",
      "description": "Additional detail objects providing error context.",
      "items": {
        "type": "object"
      }
    }
  }
}