Wasabi AiR API Reference
    • 26 Aug 2024
    • 1 Minute to read
    • PDF

    Wasabi AiR API Reference

    • PDF

    Article summary

    Wasabi AiR harvests content from storage, extracting metadata and making it available using various APIs. This reference contains the details of the APIs you need to control Wasabi AiR and access the data.

    The Wasabi AiR API is a JSON/HTTP RESTful API and, as such, uses HTTP methods and paths for requests as well as status codes and bodies in responses. All API endpoints adhere to the same policy on errors.

    Before you get started, you should understand a few high-level concepts modeled in the Wasabi AiR API:

    • Storage
    • Data
    • Harvesting

    Storage

    Content is stored at locations inside containers. Each file is called an item.

    • Locations may only contain containers, not Items.
    • Containers contain items. Think of an item as a single file.

    For example, a connection to Wasabi Console is a location. Buckets within the Console are containers. Files inside the buckets are items.

    Data

    Once harvesting has finished, you may access the metadata for an item by using the unique IDs assigned to it with the Items API. Alternatively, you can use the Search API to perform full-text queries with filters and aggregations against the metadata.

    Harvesting

    Harvesting is the process of extracting and generating metadata from a source file. Before you can initiate harvests, you must:

    • Set up and configure at least one location.

    There are two types of harvesting:

    • One-off harvesting is used to initiate a one-off harvest operation with the Harvest API.
    • Ongoing harvesting is used to continually harvest containers at a location using the Containers APIand enabling the appropriate containers. Wasabi AiR eventually harvests all the content inside that container.

      Periodically, Wasabi AiR checks the enabled containers for changes and, if it detects any, initiates a re-harvest of those items. This ensures the metadata is up-to-date. To disable this feature, use the Disable Live Harvesting endpoint.

    Getting Started

    To get started with the Wasabi AiR API, review the following articles: