Sign in
Database Queries

Insert data into database (REST API)

Changed on

Insert new rows into your database using REST API.

Authentication: Requires auth user access token

Auto-set user_id: If your table has a trigger using auth.uid(), user_id will be automatically set to the authenticated user

Security: Row-Level Security policies are enforced

Branch-targeted. Runs against the named branch instead of the parent database, using the branch's own credentials. The branch must be active and unexpired. Nothing about this request can reach the parent's data.

post/databases/{databaseName}/branches/{branchName}/query/insert

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/databases/{databaseName}/branches/{branchName}/query/insert
  • Auth: HTTP bearer

Path parameters

databaseNamestring required

Database name (unique within project, lowercase letters, numbers, and underscores only)

branchNamestring required

Branch name (unique within the parent database, lowercase letters, numbers, and underscores only)

Request body

tablestring required

Table name

valuesobject required

Column values to insert. JSON objects and arrays are stored as JSON, so send them to json or jsonb columns. For a Postgres array column, send an array literal string such as "{a,b}".

Example request

{
  "table": "posts",
  "values": {
    "title": "My New Post",
    "content": "This is the content",
    "status": "draft"
  }
}

Response

Insert successful

dataobject[]

Result rows

countinteger

Number of rows returned

Changes

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter branchName

    • ▲

      added the new path request parameter databaseName

    • ▲

      added the new required request property

    • ▲

      added the new required request property

    • ▲

      the request's body type changed from no type to object

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

  • c2ec82fb8ce8Revision changes
    • ○

      added the non-success response with the status