SnapLogic Public APIs

Overview

SnapLogic Public APIs provide basic functionality that you can use to programmatically manage your integration.

Limitations

• The timeout for the Public APIs is set to 15 minutes. You can change this timeout on the client-side network, but it remains 15 minutes in the SnapLogic Platform.
• You cannot use SnapLogic service accounts to call any of the SnapLogic Git operation APIs.

Authentication

API requests are authenticated using basic authentication over HTTPS. Future updates might include additional authentication methods. Learn more about the basic authentication header in REST API requests.

You can run these APIs regardless of the privileges or user roles assigned to you in your Environment/Org. Access to the information returned by these APIs is based on asset permissions, which are set in SnapLogic Manager.

If your account is locked or your password is expired, you cannot invoke SnapLogic Public APIs.

Best Practices

• If an API requires a reference to an account asset, refer to the account instance by its asset ID, instead of its label. You can find the asset ID of an account instance from the pipeline's metadata.
  1. Export the pipeline to view its metadata. The .slp file generated by the export is a JSON-formatted file.
  2. In the JSON tree, under snap_map, go to the branch for the Snap that uses the modified Account.
     Tip: Under snap_map, the keys are the Snap asset IDs. Use the Snap's class_fqid and class_id to help you find the appropriate Snap.
  3. Under the appropriate Snap's branch, the account's asset ID is the value of property_map.account.account_ref.value.ref_id.value.
• You can also access these APIs using the REST Get Snap with a Basic Auth account configured to access SnapLogic.