The REST API resources in this section apply specifically to
Data Ingestion and Replication
.
The section includes resources for jobs in a standard Secure Agent group and resources for
jobs in a Customer Managed runtime environment.
Use the REST APIs to create and manage
application ingestion and replication
,
database ingestion and replication
,
file ingestion and replication
, and
streaming ingestion and replication
tasks.
When you use the REST API resources, note the following rules:
All APIs use the JSON format for request
and response payloads.
If you use a tool such as Postman that
automatically includes the HTTP version, do not enter the HTTP version in the URL. If the
HTTP version appears twice in the URL, the request fails.
For resources in a standard Secure Agent
group, requests require an IDS-SESSION-ID or a similar session token in the request
headers. The base URL and URI vary by ingestion type and are based on the serverUrl value
in the login response. For the base URL, URI, header format, and examples, see the topics
for each ingestion type.
For resources in a Customer Managed
runtime environment, log in to the Secure Agent API to get a token. For more information,
see Customer Managed REST APIs for Data Ingestion and Replication.