API Reference

The API Reference documents every endpoint of the CData Arc Admin API (the REST interface for programmatically managing an Arc 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 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
Audits	Entries from the Audit Log. This resource is read-only and is available only to Admin users.
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.
FlowAPIs	REST APIs exposed by flow connectors: retrieve the HTTP method, parameters, and request/response configuration for each.
FlowConnections	Connections between connectors in a flow: retrieve, create, update, or delete the routing between flow steps.
FlowNodes	Visual layout of connector nodes in the flow designer: retrieve, create, update, or delete node position and style settings.
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).
Users	Application users: retrieve, create, update, or delete them. Available only to Admin users.
Vault	Vault items (stored secrets and reusable configuration values).
Workspaces	Workspaces that group connectors together.

Actions

Actions go beyond resource CRUD: they are 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, refreshing credentials, requeuing and counting messages, sending and receiving files, and retrieving transaction logs. See the Actions page for the full list and each action’s parameters.

Overview

Audits

Certificates

Connectors

Files

Flow APIs

Flow Connections

Flow Nodes

Logs

Profile

Reports

Requests

Transactions

Users

Vault

Workspaces

Actions

Resources

Actions

​Resources

​Actions

Resources

Actions