--- title: "Importing the Trellix IVX Cloud API into Postman" slug: "importing-the-trellix-ivx-cloud-api-into-postman" tags: ["Sec Ops and Analytics", "IVX Cloud", "Product Usage"] updated: 2026-08-24T20:18:38Z published: 2026-08-24T20:18:38Z canonical: "docs.trellix.com/importing-the-trellix-ivx-cloud-api-into-postman" stale: true --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.trellix.com/llms.txt > Use this file to discover all available pages before exploring further. # Importing the Trellix IVX Cloud API into Postman The Trellix IVX Cloud RESTful API allows you to submit files for malware analysis, search hash values, and retrieve reports. You can import the OpenAPI specification into Postman to test and integrate IVX Cloud API into your workflow. The IVX Cloud API documentation is available only through the Web UI. To access it, navigate to **Resources** → **API** within the UI. > [!NOTE] > Note > > For customers in the EU or Japan, ensure you use the correct regional endpoint URL in your environment settings to avoid request failures. **Before you begin:** - An active Trellix IVX Cloud account. - The [Postman](https://www.postman.com/downloads/) desktop application. - Your API key from the IVX Cloud web UI. 1. **Obtain the API specification** Access the YAML file URL from the IVX Cloud web UI. 1. Log in to the Trellix IVX Cloud web UI. 2. Navigate to **Resources** → **API**. 3. Copy the Trellix IVX Cloud API YAML file URL. ![IVX_Cloud_YAML_url.png](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/uuid-5d5b4b9d-e462-b25d-155d-5c1eea13cfb2.png?sv=2026-02-06&spr=https&st=2026-11-19T22%3A56%3A17Z&se=2026-11-19T23%3A56%3A17Z&sr=c&sp=r&sig=JmGmkQhBPgXKAxQanVgVJ7yZiwiX%2BQhtvZjhZosaHa8%3D) 2. **Import the IVX Cloud collection to Postman** Link the IVX Cloud schema to your workspace. 1. Open the Postman application and click **Import** in the top-left. ![IVX_CLoud_import_api.png](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/uuid-66a38918-f36d-e6fe-9073-60a49b81dea1.png?sv=2026-02-06&spr=https&st=2026-11-19T22%3A56%3A17Z&se=2026-11-19T23%3A56%3A17Z&sr=c&sp=r&sig=JmGmkQhBPgXKAxQanVgVJ7yZiwiX%2BQhtvZjhZosaHa8%3D) 2. Select the **Link** tab and paste the YAML file URL that you copied before. 3. Click **Continue**. Postman automatically creates the collection. 3. **Configure authentication** Authorize your Postman environment using your API key. 1. In Postman, right-click the new Trellix collection and select **Edit**. 2. Navigate to the **Authorization** tab. 3. Paste your API key into the **Value** field and click **Update**. 4. **Validate the integration** Test the connection by submitting a sample file for analysis. 1. Within the Trellix collection, select the first **POST** request: **Submit a single file for analysis**. 2. Click the **Body** tab. 3. Locate the **file** key. Change the type from **Text** to **File** using the dropdown menu. ![IVX_Cloud_set_file_type.png](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/uuid-60e1d8f1-d663-1ce1-8982-fe30083f2887.png?sv=2026-02-06&spr=https&st=2026-11-19T22%3A56%3A17Z&se=2026-11-19T23%3A56%3A17Z&sr=c&sp=r&sig=JmGmkQhBPgXKAxQanVgVJ7yZiwiX%2BQhtvZjhZosaHa8%3D) 4. In the **Value** field, click **Select Files** and choose a sample file from your computer. 5. Uncheck optional parameters to exclude them from the analysis submission. ![IVX_Cloud_uncheck_params.png](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/uuid-90919bf9-d540-c642-dc5a-cd3e101aecda.png?sv=2026-02-06&spr=https&st=2026-11-19T22%3A56%3A17Z&se=2026-11-19T23%3A56%3A17Z&sr=c&sp=r&sig=JmGmkQhBPgXKAxQanVgVJ7yZiwiX%2BQhtvZjhZosaHa8%3D) 6. Click **Send**. A successful response appears in the bottom pane. ![IVX_Cloud_submit_request.png](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/uuid-9f589d6b-d751-3933-1659-e9f269ee4302.png?sv=2026-02-06&spr=https&st=2026-11-19T22%3A56%3A17Z&se=2026-11-19T23%3A56%3A17Z&sr=c&sp=r&sig=JmGmkQhBPgXKAxQanVgVJ7yZiwiX%2BQhtvZjhZosaHa8%3D)