Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. Mass Ingestion Streaming REST API
  8. RunAJob utility
  9. ParamSetCli utility
  10. REST API codes
  11. REST API resource quick references

REST API Reference

REST API Reference

IP addresses

IP addresses

Use the Orgs resource to get a list of trusted IP address ranges and add trusted IP address ranges. You can also enable or disable trusted IP address filtering.
A sub-organization's trusted IP ranges are independent of the parent organization's trusted IP ranges.

GET request

To request a list of trusted IP address ranges for an organization or a sub-organization, use the following URI:
/public/core/v3/Orgs/<organization ID>/TrustedIP

GET response

If the request is successful, the response includes the following information for the organization:
Field
Type
Description
orgId
String
Organization ID.
enableIP
Boolean
Whether IP address filtering is enabled.
ipRanges
List
Trusted IP address ranges for the organization.
startIP
String
Included in the ipRanges object.
The first IP address in a range of trusted IP addresses.
endIP
String
Included in the ipRanges object.
The last IP address in a range of trusted IP addresses.

GET example

To get a list of trusted IP ranges for an organization, you might send a request similar to the following example:
GET <baseApiUrl>/public/core/v3/Orgs/6MRgiMIfvdRfUuCCCLICcI/TrustedIP
You might receive a response similar to the following example:
{ "id": "6MRgiMIfvdRfUuCCCLICcI", "enableIP": false, "ipRanges": [ { "startIP": "10.29.5.1", "endIP": "10.29.5.2" } ] }

PUT request

To add values of trusted IP ranges for an organization or a sub-organization and enable or disable trusted IP ranges, send a PUT request using the following URI:
/public/core/v3/Orgs/<organization ID>/TrustedIP
If you add trusted IP address ranges for an organization, existing trusted IP address ranges are overwritten.
Include the following information:
Field
Type
Required
Description
enableIP
Boolean
No
Whether to enable IP address filtering. If enabled, at least one IP address range must be specified.
ipRanges
List
No
IP address ranges for the organization.
startIP
String
No
Include in the ipRanges object.
The first IP address in a range of trusted IP addresses.
endIP
String
No
Include in the ipRanges object.
The last IP address in a range of trusted IP addresses.

PUT response

If the request is successful, the response includes trusted IP address information for the specified organization.

PUT example

To enable the trusted IP addresses feature for an organization and add a range of trusted IP addresses, you might send a request similar to the following example:
PUT <baseApiUrl>/public/core/v3/Orgs/6MRgiMIfvdRfUuCCCLICcI/TrustedIP Content-Type: application/json Accept: application/json INFA-SESSION-ID: 9KA11tLGqxVcGeul8SQBK3 { "enableIP": true, "ipRanges": [ { "startIP": "10.29.4.5", "endIP": "10.29.5.2" } ] }
You might receive a response similar to the following example:
{ "id": "6MRgiMIfvdRfUuCCCLICcI", "enableIP": true, "ipRanges": [ { "startIP": "10.29.4.5", "endIP": "10.29.5.2" } ] }
To add multiple ranges of trusted IP addresses, you might send a request similar to the following example:
PUT <baseApiUrl>/public/core/v3/Orgs/6MRgiMIfvdRfUuCCCLICcI/TrustedIP Content-Type: application/json Accept: application/json INFA-SESSION-ID: 9KA11tLGqxVcGeul8SQBK3 { "enableIP": true, "ipRanges": [{"startIP": "10.29.4.5", "endIP":"10.29.5.2"}, {"startIP": "10.29.10.1", "endIP":"10.29.10.5"}, {"startIP": "10.29.11.1", "endIP":"10.29.11.5"}] }
You might receive a response similar to the following example:
{ "id": "6MRgiMIfvdRfUuCCCLICcI", "enableIP": true, "ipRanges": [ { "startIP": "10.29.4.5", "endIP": "10.29.5.2" }, { "startIP": "10.29.10.1", "endIP": "10.29.10.5" }}, { "startIP": "10.29.11.1", "endIP": "10.29.11.5" } ] }

0 COMMENTS

We’d like to hear from you!