---
description: This page describes types of Aidbox REST API operations in general
---

# REST API

{% hint style="info" %}
Aidbox provides two REST APIs - FHIR and Aidbox. The main difference is [a format of resources](other/aidbox-and-fhir-formats.md). Base URL for FHIR API is **/fhir** and for Aidbox **/**

Please consider using **/fhir**. Aidbox API is scheduled for deprecation.
{% endhint %}

| Interaction type                                     |                                                                     | Format |
| ---------------------------------------------------- | ------------------------------------------------------------------- | ------ |
| **Instance Level Interactions**                      |                                                                     |        |
| [read](crud/read.md)                                 | Read the current state of the resource                              | both   |
| [vread](crud/read.md#vread)                          | Read the state of a specific version of the resource                | both   |
| [update](crud/update.md)                             | Update an existing resource by its id (or create it if it is new)   | both   |
| [patch](crud/patch.md)                               | Update an existing resource by posting a set of changes to it       | both   |
| [delete](crud/delete.md)                             | Delete a resource                                                   | both   |
| [history](history.md)                                | Retrieve the change history for a particular resource               | both   |
| **Type Level Interactions**                          |                                                                     |        |
| [create](./crud/create.md)                           | Create a new resource                                               | both   |
| [search](./fhir-search/README.md)                               | Search the resource type based on some filter criteria              | both   |
| [history](history.md)                                | Retrieve the change history for a particular resource type          | both   |
| [$dump](../bulk-api/dump.md)                        | Dump all resources of specific type                                 | Aidbox |
| [$load](../bulk-api/load-and-fhir-load.md)                        | Load resources of specific type                                     | both   |
| **Whole System Interactions**                        |                                                                     |        |
| [capabilities](./other/capability-statement.md)                     | Get a capability statement for the system                           | FHIR   |
| [batch/transaction](../batch-transaction.md)                | Update, create or delete a set of resources in a single interaction | both   |
| [batch upsert](../other/batch-upsert.md)             | Batch create or update interaction                                  | Aidbox |
| [$import](../bulk-api/import-and-fhir-import.md) | Bulk Import async operation                                         | both   |
| [$load](../bulk-api/load-and-fhir-load.md)                        | Bulk load ndjson file with resources                                | both   |
| [$dump-sql](../bulk-api/dump-sql.md)                | Bulk export result of SQL Query                                     | Aidbox |
| history                                              | Not supported for performance reason                                |        |
| search                                               | Not supported for performance reason                                |        |