> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arc.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Overview of the CData Arc Admin API reference — the REST endpoints for managing resources and running actions programmatically.

export const siteNameShort = "Arc";

export const siteName = "CData Arc";

The **API Reference** documents every endpoint of the {siteName} Admin API — the REST interface for programmatically managing an {siteNameShort} instance. Each page describes a single operation, including its HTTP method, path, parameters, and response schema, generated directly from the Admin API's OpenAPI specification.

For the concepts behind these endpoints — authentication, the `/api.rsc/` endpoint convention, CORS, and filtering — start with the [Admin API guide](../admin-api/admin-api) in the Arc User Guide. This reference then documents the individual operations, grouped into **resources** and **actions**.

## Resources

Resources are objects you query, create, update, and delete with the standard HTTP methods (`GET`, `POST`, `PUT`, `DELETE`), each exposed at `/api.rsc/<resource>`.

| Section          | What it covers                                                                                            |
| ---------------- | --------------------------------------------------------------------------------------------------------- |
| **Certificates** | Digital certificates used for encryption, signing, decryption, verification, and SSL/TLS.                 |
| **Connectors**   | Configuration for connectors in the flow — retrieve, add, update, or delete them.                         |
| **Files**        | Files in the flow — retrieve, update, and delete them, or push new files into a connector's input folder. |
| **Logs**         | Entries from the Application Log, where application-level errors are recorded.                            |
| **Profile**      | Configuration for the application's local profile.                                                        |
| **Reports**      | Reports defined in the application.                                                                       |
| **Requests**     | Entries from the Access Log, where inbound HTTP requests are recorded.                                    |
| **Transactions** | Metadata from the Transaction Log — records of successful and failed file send/receive transmissions.     |
| **Vault**        | Vault items (stored secrets and reusable configuration values).                                           |
| **Workspaces**   | Workspaces that group connectors together.                                                                |

## Actions

**Actions** go beyond resource CRUD — administrative and connector operations invoked with an HTTP `POST` to `/api.rsc/<actionName>`. They cover tasks such as cleaning up logs and folders, copying connectors and workspaces, creating and exchanging certificates, importing and exporting settings and encryption keys, requeuing and counting messages, sending and receiving files, and retrieving transaction logs.

See the [Actions](../admin-api/admin-api-actions) page for the full list and each action's parameters.
