> ## 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.

# Admin API

> Use the built-in Admin API to manage CData Arc programmatically through RESTful API calls.

export const siteName = "CData Arc";

The built-in Admin API in {siteName} provides a flexible way to manage the application. Everything that can be accomplished within the administration console UI can also be accomplished through RESTful API calls. For a complete, per-operation listing of every endpoint, see the [API Reference overview](../api-reference/overview).

The Admin API consists of a set of API [resources](./admin-api-resources) and a set of API [actions](./admin-api-actions). You can combine API calls to these resources and actions to manage the application from external scripts, servers, and applications:

* Retrieve files in the application workflow
* Retrieve metadata or log data regarding the files processed by the application
* Insert files into the application workflow for processing
* Update connector or profile configuration settings
* Trigger a connector's sending/receiving functionality

The Admin API supports JSON-formatted OData as the default REST protocol. Additional web service formats supported include OData (Atom), SOAP, HTML, and CSV.

## API Browser

The [resources](./admin-api-resources) and [actions](./admin-api-actions) sections contain an overview of the resources and actions available in the API. You can find further information on each resource and action the API browser.

To access the API browser, select **API** on the navbar. The API browser includes the available properties for each resource and action, as well as code samples (JQuery and cURL) for consuming the API.

<Note>Some 'Id' properties marked as required can be specified through a combination of other properties. For example, the 'MessageId' property of the *Files* Resource is not required to fetch a specific file if the file is identified by a combination of 'ConnectorId', 'Folder', and 'Filename'. Similarly, the Ids for the Log resources (*Logs*, *Transactions*, and *Requests*) can be omitted if not known ahead of time.</Note>