API

The DreamFactory REST API is a REST-ful implementation of our interface allowing access to the native services available on every DreamFactory instance, as well as, other remote web services that you make available on your DSP.

A very cool tool to help you with our REST API is the **Live API** module included in the Admin Console of every instance. More information on using Live API can be found [here](Admin-Console-api-sdk). An example of our **Live API** can be viewed and tested [here](https://dsp-sandman1.cloud.dreamfactory.com/swagger/).

The format of the typical DreamFactory REST API call can best be described as follows...

`<rest-verb> http[s]://<server-name>/api/v2/[<service-name>]/[<resource-path>][?<param-name>=<param-value>]`

with the following breakdown for each part...

• **_rest-verb_** - The typical REST HTTP verbs like GET, POST, PUT, DELETE. We have also added support for PATCH or MERGE. In certain services, HEAD and OPTIONS verbs may be supported as well. We also support HTTP verb tunnelling discussed in more detail [here](Common-Headers-Parameters).
• **_server-name_** - The name or IP given to the installed web server that is running the DreamFactory instance.
• **api/v2** - This is static name for accessing the REST API. Performing a **GET** here returns an array of available services when permissions allow.
• **_service-name_** - The API name of the service you want to access. Performing a GET here on most of the native services will return an array of available resources.
• **_resource-path_** - The optional resource of the service. This path may include multiple sections divided by '/' as such to define the resource.
• **_param-name_** and **_param-value_** - See Common Headers and Parameters or each specific service type for allowed URL parameters for each REST call.

This **REST API** documentation consists of the following sections. Check out the [Common Headers and Parameters](Common-Headers-Parameters) section and the [Auth Overview](Authentication and Authorization) section before digging into the other sections.

• [Common Headers and Parameters](Common-Headers-Parameters)
• [Authentication](REST-API-Authentication)
• [System Configuration](System-Configuration)

 * [Common Features](System-Common-Features)
 * [Global Config](System-Config-Resource)

• [User Profile Management](User-Profile-Management)

 * [Common Features](User-Common-Features)
 * [Session](User-Session-Resource)
 * [Password](User-Password-Resource)
 * [Profile](User-Profile-Resource)
 * [Session](User-Session-Resource)

• [Database Services](Database-Services)
• [File Storage Services](File-Storage-Services)
• [Email Services](Email-Services)
• [Remote Web Services](Remote-Web-Services)