Request App API

Learn about interacting with the Request app via the API

Base path and global segment

In order to use the Request app 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.

• 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 Request app API documentation, click https://{global-segment}.api.immutacloud.com/marketplace in the endpoint and select your global segment from the dropdown. Once you plug in your PAT, the endpoint will run and complete the actions within your Request app.

Your Request app data only exists in the same global segment as your Govern 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
}

Authentication

See instructions for generating your personal access token (PAT) on the Authentication page.

To use your generated PAT, insert it as the Bearer token for your API calls:

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

Or, if using "Test it" in the Request app API documentation, include it in the bearer token in the authentication section:

Authentication for testing

Delete a PAT

In the Request app,

1. Navigate to the Personal Access Tokens page.
2. Select the more actions icon for the PAT you want to delete.
3. Select Delete token and click Delete in the modal.

Download the Request app OpenAPI YAML

Download the Request app OpenAPI spec to import it into Postman or use a client generator tool to parse the OpenAPI definition to automatically produce client-side code.