gbox-sdk
    Preparing search index...

    Interface BoxList

    interface BoxList {
        deviceType?: string;
        labels?: unknown;
        page?: number;
        pageSize?: number;
        status?: ("error" | "running" | "all" | "pending" | "terminated")[];
        type?: ("android" | "linux" | "all")[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    deviceType?: string

    Filter boxes by their device type (virtual, physical)

    labels?: unknown

    Filter boxes by their labels. Labels are key-value pairs that help identify and categorize boxes. Use this to filter boxes that match specific label criteria. For example, you can filter by project, environment, team, or any custom labels you've added to your boxes.

    page?: number

    Page number

    pageSize?: number

    Page size

    status?: ("error" | "running" | "all" | "pending" | "terminated")[]

    Filter boxes by their current status (pending, running, stopped, error, terminated, all). Must be an array of statuses. Use 'all' to get boxes with any status.

    type?: ("android" | "linux" | "all")[]

    Filter boxes by their type (linux, android, all). Must be an array of types. Use 'all' to get boxes of any type.