RevoEngine Documentation

POST

/

api

/

v1

/

databases

Create database.

curl --request POST \
  --url https://api.revoengine.com/api/v1/databases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "restricted": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', restricted: true})
};

fetch('https://api.revoengine.com/api/v1/databases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revoengine.com/api/v1/databases"

payload = {
    "name": "<string>",
    "restricted": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "databaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "category": "<string>",
  "desc": "<string>",
  "tags": [
    "<string>"
  ],
  "restricted": true,
  "audit": true,
  "type": "TABLE",
  "definition": [
    {
      "name": "<string>",
      "type": "SMALLINT",
      "isPrimaryKey": true,
      "isArray": true,
      "isUnique": true,
      "isNullable": true,
      "isIndex": true,
      "databaseDefinitionId": "<string>",
      "desc": "<string>",
      "metadata": {},
      "default": "<string>",
      "foreignReferences": [
        {
          "reference": [
            {
              "column": "<string>",
              "targetDatabase": "<string>",
              "targetColumn": "<string>"
            }
          ],
          "onUpdate": "none",
          "onDelete": "none"
        }
      ]
    }
  ],
  "partition": {},
  "groups": [
    {}
  ],
  "users": [
    {}
  ],
  "parent": "<string>",
  "master": "<string>",
  "version": 123,
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "lastUpdateBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lastUpdateAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {}
}

Authorizations

Authorization

string

header

required

Bearer JWT token or API Key (sk-*).

Body

application/json

name

string

required

Name.

restricted

boolean

required

Provide if access should be restricted.

audit

boolean

default:false

Capture future row inserts, updates, and deletes in database audit history.

category

string

Category.

Maximum string length: 30

desc

string

Description.

Maximum string length: 1000

metadata

object

Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

groups

string[]

Provide which groups should have access to it, once restricted is true.

users

string[]

Provide which users should have access to it, once restricted is true.

definition

object[]

Database definitions.

Show child attributes

parent

string

Name.

Required string length: 1 - 60

partition

object

Partition configuration.

Show child attributes

Response

databaseId

string<uuid>

required

name

string

required

category

string | null

required

desc

string | null

required

tags

string[] | null

required

restricted

boolean

required

audit

boolean

required

Whether future row mutations are captured for this logical table.

type

enum<string>

required

Available options:

TABLE,

TABLE_PARTITIONED

definition

object[]

required

Show child attributes

partition

object | null

required

groups

object[]

required

users

object[]

required

parent

string | null

required

master

string | null

required

version

number

required

createdBy

string<uuid>

required

createdAt

string<date-time>

required

lastUpdateBy

string<uuid>

required

lastUpdateAt

string<date-time>

required

deletedAt

string<date-time> | null

required

deletedBy

string<uuid> | null

required

metadata

object

Last modified on September 5, 2026

Create database.

curl --request POST \
  --url https://api.revoengine.com/api/v1/databases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "restricted": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', restricted: true})
};

fetch('https://api.revoengine.com/api/v1/databases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revoengine.com/api/v1/databases"

payload = {
    "name": "<string>",
    "restricted": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "databaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "category": "<string>",
  "desc": "<string>",
  "tags": [
    "<string>"
  ],
  "restricted": true,
  "audit": true,
  "type": "TABLE",
  "definition": [
    {
      "name": "<string>",
      "type": "SMALLINT",
      "isPrimaryKey": true,
      "isArray": true,
      "isUnique": true,
      "isNullable": true,
      "isIndex": true,
      "databaseDefinitionId": "<string>",
      "desc": "<string>",
      "metadata": {},
      "default": "<string>",
      "foreignReferences": [
        {
          "reference": [
            {
              "column": "<string>",
              "targetDatabase": "<string>",
              "targetColumn": "<string>"
            }
          ],
          "onUpdate": "none",
          "onDelete": "none"
        }
      ]
    }
  ],
  "partition": {},
  "groups": [
    {}
  ],
  "users": [
    {}
  ],
  "parent": "<string>",
  "master": "<string>",
  "version": 123,
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "lastUpdateBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lastUpdateAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {}
}