@akamai/openapi-ts
    Preparing search index...

    Type Alias GetObjectStorageBucketContentData

    type GetObjectStorageBucketContentData = {
        body?: never;
        path: { bucket: string; regionId: string };
        query?: {
            delimiter?: string;
            marker?: string;
            page_size?: number;
            prefix?: string;
        };
        url: "object-storage/buckets/{regionId}/{bucket}/object-list";
    }
    Index

    Properties

    body? path query? url

    Properties

    Optionalbody

    body?: never
    path: { bucket: string; regionId: string }

    Type Declaration

    • bucket: string

      The bucket name.

    • regionId: string

      Identifies a region where this bucket lives.

      📘

      You can use a clusterId in place of regionId in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster id.

    query?: {
        delimiter?: string;
        marker?: string;
        page_size?: number;
        prefix?: string;
    }

    Type Declaration

    • Optionaldelimiter?: string

      The delimiter for object names; if given, object names will be returned up to the first occurrence of this character. This is most commonly used with the / character to allow bucket transversal in a manner similar to a filesystem, however any delimiter may be used. Use in conjunction with prefix to see object names past the first occurrence of the delimiter.

    • Optionalmarker?: string

      The "marker" for this request, which can be used to paginate through large buckets. Its value should be the value of the next_marker property returned with the last page. Listing bucket contents does not support arbitrary page access. See the next_marker property in the responses section for more details.

    • Optionalpage_size?: number

      The number of items to return per page.

    • Optionalprefix?: string

      Filters objects returned to only those whose name start with the given prefix. Commonly used in conjunction with delimiter to allow transversal of bucket contents in a manner similar to a filesystem.

    url: "object-storage/buckets/{regionId}/{bucket}/object-list"

    Settings

    Member Visibility

    On This Page

    Properties