Marketplace API

Private preview: The Marketplace app is available to select accounts. Reach out to your Immuta representative for details.

Immuta cannot guarantee backward compatibility with the Marketplace APIs while it is in private preview.

Base Path and Global Segment

In order to use the Marketplace API, you need to use the correct global segment. The following are the regional API base paths, choose the global segment for the region you are in.

Your Marketplace app data only exists in the same global segment as your Governance app. If you use the wrong global segment in your API call, you will receive the following response:

{
  "message": "Not authenticated.",
  "error": "Unauthorized",
  "statusCode": 401
}

• https://na.api.immutacloud.com/marketplace/ - North America

• https://eu.api.immutacloud.com/marketplace/ - European Union

• https://ap.api.immutacloud.com/marketplace/ - Asia Pacific

If using, "Test it" in the Marketplace API endpoints documentation, replace {global-segment} with the region you are in:

Update the global segment here

• na - North America

• eu - European Union

• ap - Asia Pacific

Authentication

Marketplace uses JWTs to match users with their tenants. The JWTs contain this metadata in the claims, which is required for the request context in the Marketplace API.

Generate an API key

In the Marketplace app,

1. Navigate to the API Keys page.

2. Click Generate API Key.

3. Enter a description and set an expiration. You may select "No expiration" from the dropdown.

4. Click Generate API key.

5. The new API key will be displayed. Store this key somewhere secure; it is only presented once and cannot be retrieved again later.

Authenticate with your API keys

To use your generated API keys, insert them as the Bearer token for your API calls:

curl -L \
  --url '{correct base path from above}/api/access-agreement' \
  --header 'Authorization: Bearer <your-API-key>'

Or, if using "Test It" in the Marketplace API endpoints documentation, include it in the bearer token:

Authentication for testing

Delete an API key

In the Marketplace app,

1. Navigate to the API Keys page.

2. Select the more actions icon for the API key you want to delete.

3. Select Delete key and click Delete in the modal.

Download the Marketplace OpenAPI YAML

Download the Marketplace OpenAPI YAML to import it into Postman or use a client generator tools parse the OpenAPI definition to automatically produce client-side code.

110KB

marketplace-api.yaml