Api Endpoints

From DreamFactory Wiki
Jump to navigation Jump to search

API Endpoints Reference

Complete reference for all DreamFactory REST API endpoints.

Base URL

All endpoints use the base URL format: 

https://{your-instance}/api/v2/{service_name}

Authentication

Include your API key or session token in request headers: 

X-DreamFactory-API-Key: your-api-key
X-DreamFactory-Session-Token: your-session-token

Table Operations

GET /api/v2/_table/{table_name}

Retrieve records from a table.

Parameters:

Parameter Type Description
filter string Filter expression (see Query Parameters)
limit integer Maximum records to return
offset integer Number of records to skip
order string Sort order (e.g., name ASC)
fields string Comma-separated field names
related string Related tables to include
include_count boolean Include total record count

Example Request: 

curl -X GET "https://example.com/api/v2/db/_table/contacts?limit=10&order=name%20ASC" \
  -H "X-DreamFactory-API-Key: your-api-key"

Example Response: 

{
  "resource": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "[email protected]"
    }
  ]
}

POST /api/v2/_table/{table_name}

Create one or more records.

Request Body: 

{
  "resource": [
    {
      "name": "Jane Smith",
      "email": "[email protected]"
    }
  ]
}

Example Request: 

curl -X POST "https://example.com/api/v2/db/_table/contacts" \
  -H "X-DreamFactory-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"resource": [{"name": "Jane Smith", "email": "[email protected]"}]}'

Example Response: 

{
  "resource": [
    {
      "id": 2
    }
  ]
}

PUT /api/v2/_table/{table_name}

Replace records (full update). Requires primary key in each record.

Request Body: 

{
  "resource": [
    {
      "id": 1,
      "name": "John Updated",
      "email": "[email protected]"
    }
  ]
}

Example Request: 

curl -X PUT "https://example.com/api/v2/db/_table/contacts" \
  -H "X-DreamFactory-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"resource": [{"id": 1, "name": "John Updated", "email": "[email protected]"}]}'

PATCH /api/v2/_table/{table_name}

Partial update of records. Only specified fields are modified.

Request Body: 

{
  "resource": [
    {
      "id": 1,
      "email": "[email protected]"
    }
  ]
}

Example Request: 

curl -X PATCH "https://example.com/api/v2/db/_table/contacts" \
  -H "X-DreamFactory-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"resource": [{"id": 1, "email": "[email protected]"}]}'

DELETE /api/v2/_table/{table_name}

Delete records by IDs or filter.

By IDs: 

curl -X DELETE "https://example.com/api/v2/db/_table/contacts?ids=1,2,3" \
  -H "X-DreamFactory-API-Key: your-api-key"

By Filter: 

curl -X DELETE "https://example.com/api/v2/db/_table/contacts?filter=status%3D%27inactive%27" \
  -H "X-DreamFactory-API-Key: your-api-key"

Schema Operations

GET /api/v2/_schema

List all tables in the database.

Example Request: 

curl -X GET "https://example.com/api/v2/db/_schema" \
  -H "X-DreamFactory-API-Key: your-api-key"

Example Response: 

{
  "resource": [
    {"name": "contacts"},
    {"name": "orders"},
    {"name": "products"}
  ]
}

GET /api/v2/_schema/{table_name}

Get table structure and field definitions.

Example Request: 

curl -X GET "https://example.com/api/v2/db/_schema/contacts" \
  -H "X-DreamFactory-API-Key: your-api-key"

Example Response: 

{
  "name": "contacts",
  "label": "Contacts",
  "field": [
    {
      "name": "id",
      "type": "integer",
      "db_type": "int",
      "is_primary_key": true,
      "auto_increment": true
    },
    {
      "name": "name",
      "type": "string",
      "db_type": "varchar(255)",
      "allow_null": false
    }
  ]
}

POST /api/v2/_schema

Create a new table.

Request Body: 

{
  "resource": [
    {
      "name": "new_table",
      "label": "New Table",
      "field": [
        {
          "name": "id",
          "type": "id"
        },
        {
          "name": "name",
          "type": "string",
          "length": 255
        }
      ]
    }
  ]
}

PUT /api/v2/_schema/{table_name}

Update table structure (add/modify columns).

DELETE /api/v2/_schema/{table_name}

Drop a table from the database. 

curl -X DELETE "https://example.com/api/v2/db/_schema/old_table" \
  -H "X-DreamFactory-API-Key: your-api-key"

Stored Procedures

GET /api/v2/_proc/{procedure_name}

Execute a stored procedure (no parameters or IN parameters only).

Example Request: 

curl -X GET "https://example.com/api/v2/db/_proc/get_active_users" \
  -H "X-DreamFactory-API-Key: your-api-key"

POST /api/v2/_proc/{procedure_name}

Execute a stored procedure with parameters.

Request Body: 

{
  "params": [
    {"name": "user_id", "value": 123},
    {"name": "status", "value": "active"}
  ]
}

Example Request: 

curl -X POST "https://example.com/api/v2/db/_proc/update_user_status" \
  -H "X-DreamFactory-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"params": [{"name": "user_id", "value": 123}, {"name": "status", "value": "active"}]}'

Stored Functions

GET /api/v2/_func/{function_name}

Execute a stored function. 

curl -X GET "https://example.com/api/v2/db/_func/calculate_total?order_id=456" \
  -H "X-DreamFactory-API-Key: your-api-key"

POST /api/v2/_func/{function_name}

Execute a stored function with complex parameters.

System APIs

Service Management

GET /api/v2/system/service

List all configured services. 

curl -X GET "https://example.com/api/v2/system/service" \
  -H "X-DreamFactory-API-Key: your-api-key"

POST /api/v2/system/service

Create a new service.

PUT /api/v2/system/service/{id}

Update a service configuration.

DELETE /api/v2/system/service/{id}

Delete a service.

Role Management

GET /api/v2/system/role

List all roles. 

curl -X GET "https://example.com/api/v2/system/role" \
  -H "X-DreamFactory-API-Key: your-api-key"

POST /api/v2/system/role

Create a new role.

Request Body: 

{
  "resource": [
    {
      "name": "read_only",
      "description": "Read-only access to database",
      "is_active": true
    }
  ]
}

PUT /api/v2/system/role/{id}

Update a role.

DELETE /api/v2/system/role/{id}

Delete a role.

User Management

GET /api/v2/system/user

List all users (admin only).

POST /api/v2/system/user

Create a new user (admin only).

Request Body: 

{
  "resource": [
    {
      "email": "[email protected]",
      "password": "SecurePassword123!",
      "first_name": "New",
      "last_name": "User"
    }
  ]
}

PUT /api/v2/system/user/{id}

Update a user.

DELETE /api/v2/system/user/{id}

Delete a user.

Application Management

GET /api/v2/system/app

List all applications.

POST /api/v2/system/app

Create a new application.

PUT /api/v2/system/app/{id}

Update an application.

DELETE /api/v2/system/app/{id}

Delete an application.

User APIs

Session Management

POST /api/v2/user/session

Login and create a session.

Request Body: 

{
  "email": "[email protected]",
  "password": "your-password"
}

Example Response: 

{
  "session_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "id": 5,
  "name": "User Name",
  "email": "[email protected]",
  "is_sys_admin": false,
  "session_id": "abc123..."
}

GET /api/v2/user/session

Get current session info.

DELETE /api/v2/user/session

Logout and destroy session. 

curl -X DELETE "https://example.com/api/v2/user/session" \
  -H "X-DreamFactory-Session-Token: your-session-token"

User Registration

POST /api/v2/user/register

Register a new user (if open registration is enabled).

Request Body: 

{
  "email": "[email protected]",
  "password": "SecurePassword123!",
  "first_name": "John",
  "last_name": "Doe"
}

Password Management

POST /api/v2/user/password

Request password reset or change password.

Request Reset Email: 

{
  "email": "[email protected]"
}

Change Password (authenticated): 

{
  "old_password": "current-password",
  "new_password": "new-secure-password"
}

Response Wrapper

All responses are wrapped in a resource array for consistency: 

{
  "resource": [
    { ... },
    { ... }
  ]
}

Single record responses may omit the wrapper depending on the request.

See Also

Retrieved from "https://wiki.dreamfactory.com/index.php?title=Api_Endpoints&oldid=849"