---
updatedAt: 2025-02-13T22:01:07.000Z
agentTools:
  projectIndex: https://docs.delorean-ai.com/llms.txt
---

# /api/v1/databases/{id}/

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Delorean API",
    "version": "1.25.0",
    "description": "Auto ML Engine"
  },
  "paths": {
    "/api/v1/databases/{id}/": {
      "get": {
        "operationId": "v1_databases_retrieve",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "A UUID string identifying this database.",
            "required": true
          }
        ],
        "tags": [
          "Databases"
        ],
        "security": [
          {
            "basicAuth": []
          },
          {
            "cookieAuth": []
          },
          {
            "tokenAuth": []
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RetrieveDatabase"
                }
              }
            },
            "description": ""
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "BlankEnum": {
        "enum": [
          ""
        ]
      },
      "ColumnLayout": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 90
          },
          "display_name": {
            "type": "string",
            "nullable": true,
            "maxLength": 90
          },
          "description": {
            "type": "string",
            "nullable": true,
            "maxLength": 512
          },
          "data_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DataTypeEnum"
              }
            ],
            "title": "Column type"
          },
          "required": {
            "type": "boolean"
          },
          "primary_key": {
            "type": "boolean"
          },
          "table_layout_fk": {
            "type": "integer",
            "nullable": true
          },
          "table_layout_fk_name": {
            "type": "string",
            "nullable": true,
            "readOnly": true
          },
          "db_column": {
            "type": "string",
            "nullable": true,
            "maxLength": 90
          },
          "entity_name": {
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/EntityNameEnum"
              },
              {
                "$ref": "#/components/schemas/BlankEnum"
              },
              {
                "$ref": "#/components/schemas/NullEnum"
              }
            ]
          }
        },
        "required": [
          "data_type",
          "name",
          "table_layout_fk_name"
        ]
      },
      "DataTypeEnum": {
        "enum": [
          "date",
          "datetime",
          "float",
          "int",
          "string",
          "boolean",
          "list",
          "json"
        ],
        "type": "string"
      },
      "DatabaseLayout": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "maxLength": 256
          },
          "display_name": {
            "type": "string",
            "maxLength": 256
          },
          "description": {
            "type": "string",
            "nullable": true,
            "maxLength": 256
          },
          "tables_layouts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DatabaseLayoutTableLayout"
            }
          }
        },
        "required": [
          "display_name",
          "id",
          "name",
          "tables_layouts"
        ]
      },
      "DatabaseLayoutTableLayout": {
        "type": "object",
        "properties": {
          "table_layout": {
            "$ref": "#/components/schemas/TableLayout"
          },
          "required": {
            "type": "boolean"
          }
        },
        "required": [
          "table_layout"
        ]
      },
      "EntityNameEnum": {
        "enum": [
          "transaction",
          "order",
          "item",
          "email",
          "phone",
          "cpf",
          "cnpj",
          "customer",
          "holder",
          "beneficiary",
          "health_plan",
          "company",
          "procedure",
          "occurrence",
          "address",
          "random_key"
        ],
        "type": "string"
      },
      "IntegrationTypeEnum": {
        "enum": [
          "postgres",
          "mysql",
          "sql_server",
          "oracle",
          "manual",
          "mongodb",
          "redshift",
          "bigquery"
        ],
        "type": "string"
      },
      "NestedDataFile": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "maxLength": 256
          },
          "key": {
            "type": "string",
            "readOnly": true
          },
          "delimiter": {
            "type": "string",
            "maxLength": 32
          },
          "escape": {
            "type": "string",
            "title": "Escape character",
            "maxLength": 32
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "size": {
            "type": "number",
            "format": "double",
            "nullable": true
          }
        },
        "required": [
          "created_at",
          "id",
          "key",
          "name",
          "updated_at"
        ]
      },
      "NestedIntegrationSource": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "maxLength": 256
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "integration_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/IntegrationTypeEnum"
              }
            ],
            "title": "Status"
          }
        },
        "required": [
          "created_at",
          "id",
          "name",
          "updated_at"
        ]
      },
      "NullEnum": {
        "enum": [
          null
        ]
      },
      "RetrieveDataSource": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "nullable": true,
            "maxLength": 256
          },
          "data_file": {
            "allOf": [
              {
                "$ref": "#/components/schemas/NestedDataFile"
              }
            ],
            "readOnly": true
          },
          "integration_source": {
            "allOf": [
              {
                "$ref": "#/components/schemas/NestedIntegrationSource"
              }
            ],
            "readOnly": true
          },
          "failed_etl_requests": {
            "type": "integer",
            "readOnly": true
          },
          "succeeded_etl_requests": {
            "type": "integer",
            "readOnly": true
          },
          "running_etl_requests": {
            "type": "integer",
            "readOnly": true
          },
          "not_started_etl_requests": {
            "type": "integer",
            "readOnly": true
          },
          "queued_etl_requests": {
            "type": "integer",
            "readOnly": true
          },
          "total_etl_requests": {
            "type": "integer",
            "readOnly": true
          },
          "status": {
            "type": "string",
            "readOnly": true
          }
        },
        "required": [
          "data_file",
          "failed_etl_requests",
          "id",
          "integration_source",
          "not_started_etl_requests",
          "queued_etl_requests",
          "running_etl_requests",
          "status",
          "succeeded_etl_requests",
          "total_etl_requests"
        ]
      },
      "RetrieveDatabase": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "maxLength": 256
          },
          "sample": {
            "type": "string",
            "nullable": true,
            "description": "sample of data"
          },
          "columns": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 128
            },
            "nullable": true,
            "title": "File columns"
          },
          "data_sources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RetrieveDataSource"
            }
          },
          "database_layout": {
            "$ref": "#/components/schemas/DatabaseLayout"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        },
        "required": [
          "created_at",
          "data_sources",
          "database_layout",
          "id",
          "name",
          "updated_at"
        ]
      },
      "TableLayout": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "readOnly": true
          },
          "display_name": {
            "type": "string",
            "nullable": true,
            "maxLength": 256
          },
          "name": {
            "type": "string",
            "maxLength": 256
          },
          "description": {
            "type": "string",
            "nullable": true,
            "maxLength": 256
          },
          "columns_layouts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ColumnLayout"
            }
          },
          "unique_constraint_name": {
            "type": "string",
            "nullable": true,
            "maxLength": 64
          }
        },
        "required": [
          "columns_layouts",
          "id",
          "name"
        ]
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "cookieAuth": {
        "type": "apiKey",
        "in": "cookie",
        "name": "sessionid"
      },
      "tokenAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Token-based authentication with required prefix \"Token\""
      }
    }
  },
  "servers": [
    {
      "url": "https://api.delorean-ai.com"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```