Customer Managed REST APIs for Data Ingestion and Replication
Customer Managed REST APIs for Data Ingestion and Replication
Use the REST API resources in this section to work with Data Ingestion and Replication
jobs on Secure Agents in a Customer Managed runtime environment.
First, log in to the Secure Agent API in the Customer Managed runtime environment to get
a token. Then use the token to call the resources through the Secure Agent proxy. These
calls differ from calls to Secure Agents in a standard Secure Agent group. For more
information, see Calling APIs through the agent port.
You can change the HTTPS proxy port on the Secure Agent host if you don't use the default
value. For more information, see Configure the agent port.
When you use Customer Managed REST API resources, note the following rules:
Use the JSON format for request and
response payloads.
If you use a tool such as Postman
that automatically includes the HTTP version, don't enter the HTTP version in the
URL. If the HTTP version appears twice in the URL, the request fails.
Before you can call the APIs, ensure that you've met the following conditions:
You have obtained a token. For
more information on getting the token, see Logging in.
You have a role that allows
access to Customer Managed Secure Agent APIs.
You have deployed the job to the
Customer Managed runtime environment, synchronized the deployed task, and
activated the synced assets.