Managing storage in Management API

This guide explains how to list storage entries using the Management API. In Adverity, storage entries appear under Settings → Storage and are used to stage data extracts before loading them into a destination such as Google BigQuery.

See GET /api/storage/ in the API reference.

Prerequisites

Before you complete the procedure in this guide, perform the following action:

• Use a Connect API key with Workspace: Read-only (workspace:read) to list storage entries. Without this permission, Management API returns HTTP 403. You cannot change the permissions of a key, so to add one, create a new key. For more information, see Creating a Connect API key in Adverity.

• A Connect API key cannot create, update, or delete storage entries. For more information, see Creating, updating, and deleting storage entries.

Note

This endpoint requires the Bearer scheme for the Authorization header.

Listing storage entries

To list all storage entries, follow these steps:

1. Create a GET request to the following endpoint:

   https://{{INSTANCE}}/api/storage/
   

2. In the HTTP request header, include the parameter Authorization with the value Bearer {{KEY}}.

3. Send the request.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request GET 'https://{{INSTANCE}}/api/storage/' \
--header 'Authorization: Bearer {{KEY}}'

Creating, updating, and deleting storage entries

A Connect API key cannot create, update, or delete storage entries, whichever permissions it has. These requests return HTTP 403. To create, update, or delete a storage entry, use the Adverity user interface. For more information, see Setting up storage for data extracts.

Was this page helpful? Yes No