Databases

Create database schema

Add a new database schema to the server.

Processing mode: <small><code>async</code></small>

post/orgs/{organization}/servers/{server}/database/schemas

Request

Base URL
https://forge.laravel.com/api
Auth
OAuth 2
Authorization codehttps://forge.laravel.com/oauth/authorize
Token URLhttps://forge.laravel.com/oauth/token
Scopesserver:create-databases
TypeScript
https://skmtc.dev/mfullbrook/apis/forge/docs/orgs/:organization/servers/:server/database/schemas/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationstring required

The organization slug

serverinteger required

The server ID

Request body

namestring required

The name of the database to create.

userstring nullable

The name of the database user to create. Only needed if a new user should be created alongside the database.

passwordstring nullable

The password for the database user. Only used if the user is provided.

Example request

{
  "name": "forge",
  "user": "james",
  "password": "password"
}

Response

DatabaseResource

Example response

{
  "data": {
    "attributes": {
      "name": "forge",
      "status": "installed",
      "created_at": "2025-07-29T09:00:00Z",
      "updated_at": "2025-07-30T09:00:00Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.