Public APIs

SnapLogic Public APIs provide programmatic management for your environment and project assets. Use of the SnapLogic Public APIs doesn't count against the environment limit for calling pipelines with the Cloud URL.

Tip: You can create custom APIs from your pipelines using the SnapLogic API Management tool.

Limitations

  • You cannot use SnapLogic service accounts to call any of the SnapLogic Git operation APIs.

Authentication

The SnapLogic Platform authenticates API calls with basic authentication over HTTPS. Future updates might include additional authentication methods. If your account is locked or your password is expired, you cannot invoke SnapLogic Public APIs.Learn more about the basic authentication header in REST API requests.

In the request header, specify Basic for authorization, add your credentials, and specify application/json for content type:


Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

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.

Some APIs require the caller to have administrative permission. Others, such as task and runtime APIs, require read or write access to the assets. Environment admins set project-level permissions in Classic Manager. The creator of an asset has full access to that asset. The following table shows the mapping between permissions defined in Classic Manager and API permissions. Each API documentation page specifies the permission required to call the API.

Manager Permissions API Permissions
Full Access ["R", "W", "X"]
Read & Execute ["R", "X"]
Read & Write ["R", "W"]
Read Only ["R"]

Base URL

The base URL of SnapLogic APIs includes the path to the control plane that hosts your environment: https://{controlplane_path}

Key Description
controlplane_path Required. The path to the SnapLogic Control Plane: elastic.snaplogic.com
For the UAT or EMEA control plane, substitute the name for elastic. For example:
  • uat.snaplogic.com
  • emea.snaplogic.com

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.