# CData Arc Documentation: English 26.3 Self-Hosted API Reference

## API Reference

### Overview

- [API Reference](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/overview.md): Overview of the CData Arc Admin API reference — the REST endpoints for managing resources and running actions programmatically.

### Certificates

- [Return certificates](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/certificates/return-certificates.md): Returns records from the certificates entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Create certificates](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/certificates/create-certificates.md): Creates a new certificates object with the specified parameters.
- [Return count of certificates](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/certificates/return-count-of-certificates.md): Returns count of records from the certificates entity that match the specified query parameters.  All count will be returned when no parameters are specified.
- [Return a single certificates](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/certificates/return-a-single-certificates.md): Returns a single certificates object using the specified key.
- [Delete certificates](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/certificates/delete-certificates.md): Deletes the specified certificates object.
- [Return specified property value of specified certificates](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/certificates/return-specified-property-value-of-specified-certificates.md): Returns property value of certificates object using the specified key and property name.

### Connectors

- [Return connectors](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/connectors/return-connectors.md): Returns records from the connectors entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Create connectors](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/connectors/create-connectors.md): Creates a new connectors object with the specified parameters.
- [Return count of connectors](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/connectors/return-count-of-connectors.md): Returns count of records from the connectors entity that match the specified query parameters.  All count will be returned when no parameters are specified.
- [Return a single connectors](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/connectors/return-a-single-connectors.md): Returns a single connectors object using the specified key.
- [Update connectors](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/connectors/update-connectors.md): Updates the specified connectors object.
- [Delete connectors](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/connectors/delete-connectors.md): Deletes the specified connectors object.
- [Return specified property value of specified connectors](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/connectors/return-specified-property-value-of-specified-connectors.md): Returns property value of connectors object using the specified key and property name.

### Files

- [Return files](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/files/return-files.md): Returns records from the files entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Create files](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/files/create-files.md): Creates a new files object with the specified parameters.
- [Return count of files](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/files/return-count-of-files.md): Returns count of records from the files entity that match the specified query parameters.  All count will be returned when no parameters are specified.
- [Return a single files](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/files/return-a-single-files.md): Returns a single files object using the specified key.
- [Update files](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/files/update-files.md): Updates the specified files object.
- [Delete files](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/files/delete-files.md): Deletes the specified files object.
- [Return specified property value of specified files](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/files/return-specified-property-value-of-specified-files.md): Returns property value of files object using the specified key and property name.

### Flow APIs

- [Return flowAPIs](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-apis/return-flowapis.md): Returns records from the flowAPIs entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Return count of flowAPIs](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-apis/return-count-of-flowapis.md): Returns count of records from the flowAPIs entity that match the specified query parameters.  All count will be returned when no parameters are specified.
- [Return a single flowAPIs](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-apis/return-a-single-flowapis.md): Returns a single flowAPIs object using the specified key.
- [Return specified property value of specified flowAPIs](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-apis/return-specified-property-value-of-specified-flowapis.md): Returns property value of flowAPIs object using the specified key and property name.

### Flow Connections

- [Return flowConnections](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-connections/return-flowconnections.md): Returns records from the flowConnections entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Create flowConnections](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-connections/create-flowconnections.md): Creates a new flowConnections object with the specified parameters.
- [Return count of flowConnections](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-connections/return-count-of-flowconnections.md): Returns count of records from the flowConnections entity that match the specified query parameters.  All count will be returned when no parameters are specified.
- [Return a single flowConnections](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-connections/return-a-single-flowconnections.md): Returns a single flowConnections object using the specified key.
- [Update flowConnections](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-connections/update-flowconnections.md): Updates the specified flowConnections object.
- [Delete flowConnections](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-connections/delete-flowconnections.md): Deletes the specified flowConnections object.
- [Return specified property value of specified flowConnections](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-connections/return-specified-property-value-of-specified-flowconnections.md): Returns property value of flowConnections object using the specified key and property name.

### Flow Nodes

- [Return flowNodes](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-nodes/return-flownodes.md): Returns records from the flowNodes entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Create flowNodes](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-nodes/create-flownodes.md): Creates a new flowNodes object with the specified parameters.
- [Return count of flowNodes](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-nodes/return-count-of-flownodes.md): Returns count of records from the flowNodes entity that match the specified query parameters.  All count will be returned when no parameters are specified.
- [Return a single flowNodes](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-nodes/return-a-single-flownodes.md): Returns a single flowNodes object using the specified key.
- [Update flowNodes](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-nodes/update-flownodes.md): Updates the specified flowNodes object.
- [Delete flowNodes](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-nodes/delete-flownodes.md): Deletes the specified flowNodes object.
- [Return specified property value of specified flowNodes](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/flow-nodes/return-specified-property-value-of-specified-flownodes.md): Returns property value of flowNodes object using the specified key and property name.

### Logs

- [Return logs](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/logs/return-logs.md): Returns records from the logs entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Return count of logs](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/logs/return-count-of-logs.md): Returns count of records from the logs entity that match the specified query parameters.  All count will be returned when no parameters are specified.
- [Return a single logs](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/logs/return-a-single-logs.md): Returns a single logs object using the specified key.
- [Delete logs](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/logs/delete-logs.md): Deletes the specified logs object.
- [Return specified property value of specified logs](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/logs/return-specified-property-value-of-specified-logs.md): Returns property value of logs object using the specified key and property name.

### Profile

- [Return profile](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/profile/return-profile.md): Returns records from the profile entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Update profile](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/profile/update-profile.md): Updates the specified profile object.
- [Return count of profile](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/profile/return-count-of-profile.md): Returns count of records from the profile entity that match the specified query parameters.  All count will be returned when no parameters are specified.

### Reports

- [Return reports](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/reports/return-reports.md): Returns records from the reports entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Create reports](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/reports/create-reports.md): Creates a new reports object with the specified parameters.
- [Return count of reports](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/reports/return-count-of-reports.md): Returns count of records from the reports entity that match the specified query parameters.  All count will be returned when no parameters are specified.
- [Return a single reports](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/reports/return-a-single-reports.md): Returns a single reports object using the specified key.
- [Update reports](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/reports/update-reports.md): Updates the specified reports object.
- [Delete reports](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/reports/delete-reports.md): Deletes the specified reports object.
- [Return specified property value of specified reports](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/reports/return-specified-property-value-of-specified-reports.md): Returns property value of reports object using the specified key and property name.

### Requests

- [Return requests](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/requests/return-requests.md): Returns records from the requests entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Return count of requests](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/requests/return-count-of-requests.md): Returns count of records from the requests entity that match the specified query parameters.  All count will be returned when no parameters are specified.
- [Return a single requests](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/requests/return-a-single-requests.md): Returns a single requests object using the specified key.
- [Delete requests](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/requests/delete-requests.md): Deletes the specified requests object.
- [Return specified property value of specified requests](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/requests/return-specified-property-value-of-specified-requests.md): Returns property value of requests object using the specified key and property name.

### Transactions

- [Return transactions](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/transactions/return-transactions.md): Returns records from the transactions entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Return count of transactions](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/transactions/return-count-of-transactions.md): Returns count of records from the transactions entity that match the specified query parameters.  All count will be returned when no parameters are specified.
- [Return a single transactions](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/transactions/return-a-single-transactions.md): Returns a single transactions object using the specified key.
- [Delete transactions](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/transactions/delete-transactions.md): Deletes the specified transactions object.
- [Return specified property value of specified transactions](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/transactions/return-specified-property-value-of-specified-transactions.md): Returns property value of transactions object using the specified key and property name.

### Vault

- [Return vault](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/vault/return-vault.md): Returns records from the vault entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Create vault](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/vault/create-vault.md): Creates a new vault object with the specified parameters.
- [Return count of vault](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/vault/return-count-of-vault.md): Returns count of records from the vault entity that match the specified query parameters.  All count will be returned when no parameters are specified.
- [Return a single vault](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/vault/return-a-single-vault.md): Returns a single vault object using the specified key.
- [Update vault](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/vault/update-vault.md): Updates the specified vault object.
- [Delete vault](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/vault/delete-vault.md): Deletes the specified vault object.
- [Return specified property value of specified vault](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/vault/return-specified-property-value-of-specified-vault.md): Returns property value of vault object using the specified key and property name.

### Workspaces

- [Return workspaces](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/workspaces/return-workspaces.md): Returns records from the workspaces entity that match the specified query parameters.  All records will be returned when no parameters are specified.
- [Create workspaces](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/workspaces/create-workspaces.md): Creates a new workspaces object with the specified parameters.
- [Return count of workspaces](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/workspaces/return-count-of-workspaces.md): Returns count of records from the workspaces entity that match the specified query parameters.  All count will be returned when no parameters are specified.
- [Return a single workspaces](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/workspaces/return-a-single-workspaces.md): Returns a single workspaces object using the specified key.
- [Update workspaces](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/workspaces/update-workspaces.md): Updates the specified workspaces object.
- [Delete workspaces](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/workspaces/delete-workspaces.md): Deletes the specified workspaces object.
- [Return specified property value of specified workspaces](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/workspaces/return-specified-property-value-of-specified-workspaces.md): Returns property value of workspaces object using the specified key and property name.

### Actions

- [Archive or delete log files, transaction entries in the database, and, optionally, files in the Send, Sent, and Received folders, for the specified workspaces and connectors.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/archive-or-delete-log-files-transaction-entries-in-the-database-and-optionally-files-in-the-send-sent-and-received-folders-for-the-specified-workspaces-and-connectors.md): Archive or delete log files, transaction entries in the database, and, optionally, files in the Send, Sent, and Received folders, for the specified workspaces and connectors.
- [Copies connector settings from an existing connector to a new connector.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/copies-connector-settings-from-an-existing-connector-to-a-new-connector.md): Copies connector settings from an existing connector to a new connector.
- [Copies the workspace settings and all connectors from an existing workspace to a new workspace.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/copies-the-workspace-settings-and-all-connectors-from-an-existing-workspace-to-a-new-workspace.md): Copies the workspace settings and all connectors from an existing workspace to a new workspace.
- [Creates a public/private certificate key pair that can be used for encryption, signing, decryption, verification, SSL/TLS, and so on.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/creates-a-public-private-certificate-key-pair-that-can-be-used-for-encryption-signing-decryption-verification-ssl-tls-and-so-on.md): Creates a public/private certificate key pair that can be used for encryption, signing, decryption, verification, SSL/TLS, and so on.
- [Exchange the specified certificate with a trading partner. Only applicable for AS2 and OFTP connectors.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/exchange-the-specified-certificate-with-a-trading-partner-only-applicable-for-as2-and-oftp-connectors.md): Exchange the specified certificate with a trading partner. Only applicable for AS2 and OFTP connectors.
- [Creates an arcflow configuration file that includes profiles settings, connector settings, and/or workspace settings.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/creates-an-arcflow-configuration-file-that-includes-profiles-settings-connector-settings-and-or-workspace-settings.md): Creates an arcflow configuration file that includes profiles settings, connector settings, and/or workspace settings.
- [Exports the master encryption key as an encrypted data block that contains the data encryption key and its associated cryptographic metadata.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/exports-the-master-encryption-key-as-an-encrypted-data-block-that-contains-the-data-encryption-key-and-its-associated-cryptographic-metadata.md): Exports the master encryption key as an encrypted data block that contains the data encryption key and its associated cryptographic metadata.
- [Retrieve the unsent messages count for connectors (the count of all messages in the Send folder).](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/retrieve-the-unsent-messages-count-for-connectors-the-count-of-all-messages-in-the-send-folder.md): Retrieve the unsent messages count for connectors (the count of all messages in the Send folder).
- [Retrieves the transaction logs for a specific transaction, optionally including the log content.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/retrieves-the-transaction-logs-for-a-specific-transaction-optionally-including-the-log-content.md): Retrieves the transaction logs for a specific transaction, optionally including the log content.
- [Import workspaces, connectors and profiles from a configuration arcflow file.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/import-workspaces-connectors-and-profiles-from-a-configuration-arcflow-file.md): Import workspaces, connectors and profiles from a configuration arcflow file.
- [Imports an encryption key (typically exported from a production environment) into a development or test instance, enabling the development environment to decrypt configuration data and credentials from production backups or imports.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/imports-an-encryption-key-typically-exported-from-a-production-environment-into-a-development-or-test-instance-enabling-the-development-environment-to-decrypt-configuration-data-and-credentials-from-production-backups-or-imports.md): Imports an encryption key (typically exported from a production environment) into a development or test instance, enabling the development environment to decrypt configuration data and credentials from production backups or imports.
- [Moves a connector (settings, state and transaction history) from one workspace to another, or renames it within the same workspace. The original connector is removed.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/moves-a-connector-settings-state-and-transaction-history-from-one-workspace-to-another-or-renames-it-within-the-same-workspace-the-original-connector-is-removed.md): Moves a connector (settings, state and transaction history) from one workspace to another, or renames it within the same workspace. The original connector is removed.
- [Triggers the Receive action for a specific connector to receive one or more specified file(s).](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/triggers-the-receive-action-for-a-specific-connector-to-receive-one-or-more-specified-file-s.md): Triggers the Receive action for a specific connector to receive one or more specified file(s).
- [Moves a message back into the connector's Send folder so it can be processed again. Use this to retry messages that failed or need to be reprocessed.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/moves-a-message-back-into-the-connector-s-send-folder-so-it-can-be-processed-again-use-this-to-retry-messages-that-failed-or-need-to-be-reprocessed.md): Moves a message back into the connector's Send folder so it can be processed again. Use this to retry messages that failed or need to be reprocessed.
- [Instructs a specific connector to process (upload, send, transform, and so on) a file in that connector's Send folder.](https://docs.arc.cdata.com/26.3/self-hosted/en/api-reference/actions/instructs-a-specific-connector-to-process-upload-send-transform-and-so-on-a-file-in-that-connector-s-send-folder.md): Instructs a specific connector to process (upload, send, transform, and so on) a file in that connector's Send folder.

## OpenAPI Specs

- [openapi](/26.3/self-hosted/en/api-reference/openapi.json)