REST API Reference

Back Next

Customer Managed REST API

The REST API resources in this section apply specifically to Secure Agents running in a Customer Managed runtime environment.

Use the REST APIs to log in to a Customer Managed runtime environment and to call

IDMC

APIs through the proxy. This is different from API calls to Secure Agents in a standard Secure Agent group. For more information, see Calling APIs through the proxy.

You can change the HTTPS proxy port on the Secure Agent host if you don't use the default value.

When you use Customer Managed runtime environments, note the following rules:

Use the base URL:

https://<serverUrl>/rm/saas

Where

is comprised of

<host-ip>:<port>

For example, to run a job in a Customer Managed runtime environment, use the following call:

POST https://<serverUrl>/rm/saas/api/v2/job/42

Use the JSON format for request and response payloads.

When you log in, you obtain a token that you'll use for calling

IDMC

APIs through the proxy.

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.

Configure the proxy port

Logging in

Calling APIs through the proxy

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal