API Reference#
The API reference is organised by API technology (SOAP, REST, and GraphQL) and provides detailed technical information, including request parameters, authentication requirements, and response formats.
Select an API below to access its reference documentation.
SOAP API#
SOAP APIs provide access to user-level and administrative operations.
The following table lists the available SOAP API categories:
API |
Access level |
Description |
|---|---|---|
User |
Operations related to user accounts. |
|
User |
Operations related to user mailboxes. |
|
Administrator |
Operations for managing accounts, domains, and server configuration. |
REST API#
REST APIs expose HTTP endpoints for interacting with specific Carbonio services.
The following table lists the available REST API categories:
API |
Description |
|---|---|
Endpoints for login and authentication operations. |
|
Endpoints for configuring SAML authentication. |
|
Endpoints for backup operations. |
|
Endpoints for accessing file blobs. |
|
Endpoints for interacting with storage, including file upload, download, deletion, and copy operations. |
|
Endpoints for storage quota operations. |
|
Endpoints for chat-related operations. |
GraphQL API#
The GraphQL API allows clients to retrieve structured data through queries, selecting the fields they need.
The following table lists the available GraphQL API categories:
API |
Description |
|---|---|
GraphQL operations for retrieving files metadata. |