> ## Documentation Index > Fetch the complete documentation index at: https://cloud.laravel.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get a database > Get a specific database. ## OpenAPI ````yaml https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/databases/{schema} openapi: 3.1.0 info: title: Laravel Cloud version: 0.0.1 servers: - url: https://cloud.laravel.com/api security: - http: [] tags: - name: Applications - name: Environments - name: Domains - name: Commands - name: Deployments - name: Instances - name: Background Processes - name: Database Clusters - name: Databases - name: Database Snapshots - name: Database Restores - name: Object Storage Buckets - name: Bucket Keys - name: Caches - name: WebSocket Clusters - name: WebSocket Applications - name: Dedicated Clusters - name: Usage - name: Meta - name: Databases (Legacy) paths: /databases/clusters/{database}/databases/{schema}: get: tags: - Databases summary: Get a database description: Get a specific database. operationId: public.databases.clusters.databases.show parameters: - name: database in: path required: true description: The database identifier schema: type: - string - 'null' - name: schema in: path required: true description: The schema identifier schema: type: string - name: include in: query schema: type: array items: type: string enum: - database - environments explode: false responses: '200': description: '`DatabaseSchemaResource`' content: application/vnd.api+json: schema: type: object properties: data: $ref: '#/components/schemas/DatabaseSchemaResource' included: type: array items: anyOf: - $ref: '#/components/schemas/DatabaseResource' - $ref: '#/components/schemas/EnvironmentResource' required: - data '404': $ref: '#/components/responses/ModelNotFoundException' components: schemas: DatabaseSchemaResource: type: object properties: id: type: string type: type: string enum: - databaseSchemas attributes: type: object properties: name: type: string status: type: string created_at: type: - string - 'null' format: date-time required: - name - status - created_at relationships: type: object properties: database: type: object properties: data: anyOf: - $ref: '#/components/schemas/DatabaseResourceIdentifier' - type: 'null' required: - data environments: type: object properties: data: type: array items: $ref: '#/components/schemas/EnvironmentResourceIdentifier' required: - data required: - id - type title: DatabaseSchemaResource DatabaseResource: type: object properties: id: type: string type: type: string enum: - databases attributes: type: object properties: name: type: string type: $ref: '#/components/schemas/DatabaseType' status: $ref: '#/components/schemas/DatabaseStatus' region: $ref: '#/components/schemas/CloudRegion' created_at: type: - string - 'null' format: date-time config: description: Configuration object. Fields vary based on database type. oneOf: - title: Neon Serverless Postgres type: object description: Configuration for Neon Serverless Postgres databases properties: cu_min: type: number description: Minimum compute units for auto-scaling enum: - 0.25 - 0.5 - 1 - 2 - 4 - 8 - 10 cu_max: type: number description: Maximum compute units for auto-scaling enum: - 0.25 - 0.5 - 1 - 2 - 4 - 8 - 10 suspend_seconds: type: integer description: >- Seconds of inactivity before hibernation (0 = never) (min: 0, max: 604800) retention_days: type: integer description: >- Days to retain point-in-time recovery data (min: 0, max: 30) required: - cu_min - cu_max - suspend_seconds - retention_days - title: Laravel MySQL type: object description: Configuration for Laravel MySQL databases properties: size: type: string description: Instance size for the database cluster enum: - db-flex.m-1vcpu-512mb - db-flex.m-1vcpu-1gb - db-flex.m-1vcpu-2gb - db-flex.m-1vcpu-4gb - db-pro.m-1vcpu-4gb - db-pro.m-2vcpu-8gb - db-pro.m-4vcpu-16gb - db-pro.m-8vcpu-32gb storage: type: integer description: 'Storage allocation in gigabytes (min: 5, max: 1000)' is_public: type: boolean description: Whether the database is publicly accessible uses_scheduled_snapshots: type: boolean description: Whether scheduled backups are enabled retention_days: type: integer description: 'Days to retain backup data (min: 0, max: 30)' maintenance_window: type: - string - 'null' description: UTC maintenance window for automated updates example: sun:06:00-sun:06:30 suspend_seconds: type: integer description: >- Seconds of inactivity before scaling to zero (0 = never). Requires an eligible size and the scale-to-zero feature. (min: 0, max: 3600) required: - size - storage - is_public - uses_scheduled_snapshots - retention_days - title: AWS RDS type: object description: Configuration for AWS RDS MySQL databases properties: size: type: string description: Instance size for the database cluster enum: - db.m8g.large - db.m8g.xlarge - db.m8g.2xlarge - db.m8g.4xlarge - db.m8g.8xlarge - db.m8g.12xlarge - db.m8g.16xlarge - db.m8g.24xlarge - db.m8g.48xlarge - db.m7g.large - db.m7g.xlarge - db.m7g.2xlarge - db.m7g.4xlarge - db.m7g.8xlarge - db.m7g.12xlarge - db.m7g.16xlarge - db.t4g.micro - db.t4g.small - db.t4g.medium - db.t4g.large - db.t4g.xlarge - db.t4g.2xlarge storage: type: integer description: 'Storage allocation in gigabytes (min: 5, max: 1000)' is_public: type: boolean description: Whether the database is publicly accessible uses_pitr: type: boolean description: Whether point-in-time recovery is enabled retention_days: type: integer description: 'Days to retain backup data (min: 0, max: 30)' maintenance_window: type: - string - 'null' description: UTC maintenance window for automated updates example: sun:06:00-sun:06:30 deployment_option: type: string description: Deployment configuration (single-az or multi-az) enum: - single-az - single-az-with-read-replicas - multi-az read_replicas: type: - integer - 'null' description: The number of configured read replicas required: - size - storage - is_public - uses_pitr - retention_days - deployment_option discriminator: propertyName: type mapping: laravel_mysql_84: '#/components/schemas/LaravelMysqlConfig' laravel_mysql_8: '#/components/schemas/LaravelMysqlConfig' aws_rds_mysql_8: '#/components/schemas/AwsRdsConfig' aws_rds_postgres_18: '#/components/schemas/AwsRdsConfig' neon_serverless_postgres_18: '#/components/schemas/NeonServerlessConfig' neon_serverless_postgres_17: '#/components/schemas/NeonServerlessConfig' neon_serverless_postgres_16: '#/components/schemas/NeonServerlessConfig' connection: type: object properties: hostname: type: string port: type: integer enum: - 3306 - 5432 protocol: type: string enum: - mysql - postgres driver: type: string enum: - mysql - pgsql username: type: string password: type: string required: - hostname - port - protocol - driver - username - password required: - name - type - status - region - created_at - config - connection relationships: type: object properties: schemas: type: object description: 'TODO: Remove the schemas relationship by March 2026.' properties: data: type: array items: $ref: '#/components/schemas/DatabaseSchemaResourceIdentifier' required: - data databases: type: object properties: data: type: array items: $ref: '#/components/schemas/DatabaseSchemaResourceIdentifier' required: - data required: - id - type title: DatabaseResource EnvironmentResource: type: object properties: id: type: string type: type: string enum: - environments attributes: type: object properties: name: type: string slug: type: string status: $ref: '#/components/schemas/EnvironmentStatus' created_from_automation: type: boolean vanity_domain: type: string php_major_version: type: string enum: - '8.2' - '8.3' - '8.4' - '8.5' build_command: type: - string - 'null' node_version: $ref: '#/components/schemas/NodeVersion' deploy_command: type: - string - 'null' uses_octane: type: boolean uses_hibernation: type: boolean hibernation_wake_up_interval: type: - integer - 'null' uses_push_to_deploy: type: boolean uses_deploy_hook: type: boolean environment_variables: type: array items: type: object properties: key: type: string value: type: string required: - key - value network_settings: type: object properties: cache: type: object properties: strategy: type: string required: - strategy response_headers: type: object properties: frame: type: string content_type: type: string hsts: type: object properties: max_age: type: integer include_subdomains: type: boolean preload: type: boolean required: - max_age - include_subdomains - preload required: - frame - content_type - hsts firewall: type: object properties: bot_categories: type: array items: $ref: '#/components/schemas/BotControlCategory' rate_limit: type: object properties: '429': type: boolean level: $ref: '#/components/schemas/RateLimitLevel' per_minute: $ref: '#/components/schemas/RateLimitPerMinute' 4xx: type: boolean required: - level - per_minute - 4xx - '429' under_attack_mode_started_at: type: string block_path: type: boolean required: - bot_categories - rate_limit - under_attack_mode_started_at - block_path content_converter: type: boolean required: - cache - response_headers - firewall - content_converter created_at: type: - string - 'null' format: date-time required: - name - slug - status - created_from_automation - vanity_domain - php_major_version - build_command - node_version - deploy_command - uses_octane - uses_hibernation - hibernation_wake_up_interval - uses_push_to_deploy - uses_deploy_hook - environment_variables - network_settings - created_at relationships: type: object properties: application: type: object properties: data: anyOf: - $ref: '#/components/schemas/ApplicationResourceIdentifier' - type: 'null' required: - data branch: type: object properties: data: anyOf: - $ref: '#/components/schemas/BranchResourceIdentifier' - type: 'null' required: - data deployments: type: object properties: data: type: array items: $ref: '#/components/schemas/DeploymentResourceIdentifier' required: - data currentDeployment: type: object properties: data: anyOf: - $ref: '#/components/schemas/DeploymentResourceIdentifier' - type: 'null' required: - data domains: type: object properties: data: type: array items: $ref: '#/components/schemas/DomainResourceIdentifier' required: - data primaryDomain: type: object properties: data: anyOf: - $ref: '#/components/schemas/DomainResourceIdentifier' - type: 'null' required: - data instances: type: object properties: data: type: array items: $ref: '#/components/schemas/InstanceResourceIdentifier' required: - data database: type: object properties: data: anyOf: - $ref: '#/components/schemas/DatabaseSchemaResourceIdentifier' - type: 'null' required: - data cache: type: object properties: data: anyOf: - $ref: '#/components/schemas/CacheResourceIdentifier' - type: 'null' required: - data buckets: type: object properties: data: type: array items: $ref: '#/components/schemas/FilesystemResourceIdentifier' required: - data websocketApplication: type: object properties: data: anyOf: - $ref: >- #/components/schemas/WebsocketApplicationResourceIdentifier - type: 'null' required: - data links: type: object properties: self: $ref: '#/components/schemas/Link' required: - self required: - id - type - links title: EnvironmentResource DatabaseResourceIdentifier: type: object properties: type: type: string enum: - databases id: type: string required: - type - id title: DatabaseResourceIdentifier EnvironmentResourceIdentifier: type: object properties: type: type: string enum: - environments id: type: string required: - type - id title: EnvironmentResourceIdentifier DatabaseType: type: string enum: - laravel_mysql_84 - laravel_mysql_8 - aws_rds_mysql_8 - aws_rds_postgres_18 - neon_serverless_postgres_18 - neon_serverless_postgres_17 - neon_serverless_postgres_16 title: DatabaseType DatabaseStatus: type: string enum: - creating - updating - restarting - upgrading - moving - available - stopped - restoring - restore_failed - disabled - snapshotting_before_archiving - archiving - archived - deleting - deleted - unknown title: DatabaseStatus CloudRegion: type: string enum: - us-east-2 - us-east-1 - ca-central-1 - eu-central-1 - eu-west-1 - eu-west-2 - me-central-1 - ap-southeast-1 - ap-southeast-2 - ap-northeast-1 title: CloudRegion DatabaseSchemaResourceIdentifier: type: object properties: type: type: string enum: - databaseSchemas id: type: string required: - type - id title: DatabaseSchemaResourceIdentifier EnvironmentStatus: type: string enum: - deploying - running - hibernating - stopped title: EnvironmentStatus NodeVersion: type: string enum: - '20' - '22' - '24' title: NodeVersion BotControlCategory: type: string enum: - academic_research - accessibility - advertising_and_marketing - aggregator - ai_assistant - ai_crawler - ai_search - feed_fetcher - monitoring_and_analytics - page_preview - search_engine_crawler - search_engine_optimization - security - social_media_marketing - webhooks - other title: BotControlCategory RateLimitLevel: type: string enum: - challenge - throttle - ban title: RateLimitLevel RateLimitPerMinute: type: integer enum: - 100 - 300 - 500 - 750 - 1000 title: RateLimitPerMinute ApplicationResourceIdentifier: type: object properties: type: type: string enum: - applications id: type: string required: - type - id title: ApplicationResourceIdentifier BranchResourceIdentifier: type: object properties: type: type: string enum: - branches id: type: string required: - type - id title: BranchResourceIdentifier DeploymentResourceIdentifier: type: object properties: type: type: string enum: - deployments id: type: string required: - type - id title: DeploymentResourceIdentifier DomainResourceIdentifier: type: object properties: type: type: string enum: - domains id: type: string required: - type - id title: DomainResourceIdentifier InstanceResourceIdentifier: type: object properties: type: type: string enum: - instances id: type: string required: - type - id title: InstanceResourceIdentifier CacheResourceIdentifier: type: object properties: type: type: string enum: - caches id: type: string required: - type - id title: CacheResourceIdentifier FilesystemResourceIdentifier: type: object properties: type: type: string enum: - filesystems id: type: string required: - type - id title: FilesystemResourceIdentifier WebsocketApplicationResourceIdentifier: type: object properties: type: type: string enum: - websocketApplications id: type: string required: - type - id title: WebsocketApplicationResourceIdentifier Link: type: object properties: href: type: string format: uri rel: type: string describedby: type: string title: type: string type: type: string hreflang: anyOf: - type: string - type: array items: type: string meta: type: object required: - href title: Link responses: ModelNotFoundException: description: Not found content: application/json: schema: type: object properties: message: type: string description: Error overview. required: - message securitySchemes: http: type: http description: The Bearer Token generated on the Cloud UI. scheme: bearer bearerFormat: bearer ````