REST API Reference

Back Next

Database and application ingestion and replication Customer Managed REST APIs

Use these resources to start, stop, abort, and resync

database ingestion and replication

jobs and

application ingestion and replication

jobs in a Customer Managed runtime environment. You can also get the job status and job details.

For other actions, such as deploy, redeploy, and undeploy, use the user interface when IDMC can reach the Customer Managed runtime environment.

To call resources, use the following base URL, where <agent-host> is the host name or IP address of the machine where the Customer Managed runtime environment runs:

https://<agent-host>:9443/rm/dbmi/api/v1

For example, if the agent host is invrlx7b2b8.informatica.com, the base URL is https://invrlx7b2b8.informatica.com:9443/rm/dbmi/api/v1.

Authentication

Before you call a resource, log in and get a token. For more information, see Logging in. Send the token in the RM-USER-TOKEN header of every request. Replace <rm-token> with the token from the login response.

RM-USER-TOKEN: <rm-token>

For example, to get the status of a job, run the following curl command with your token in the RM-USER-TOKEN header:

curl -k https://invrlx7b2b8.informatica.com:9443/rm/dbmi/api/v1/job/150768/status \
     -H "RM-USER-TOKEN: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzYW1wbGUtdXNlciJ9.c2FtcGxlLXNpZ25hdHVyZQ"

Keep the following in mind when you call the APIs:

The token expires after about 30 minutes. Log in again to get a new token.

Use straight quotes in the JSON body. Curly quotes make the body invalid and return a 400 error.

The curl examples use -k because the endpoint can serve a self-signed certificate. Remove -k when a trusted certificate is installed.