> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List a folder

> One level of a folder (at most 100 entries a page), showing only the
folders and objects Ranger lets you read.



## OpenAPI

````yaml get /api/storage/buckets/{bucket}/objects
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/storage/buckets/{bucket}/objects:
    get:
      tags:
        - Object storage
      summary: List a folder
      description: |-
        One level of a folder (at most 100 entries a page), showing only the
        folders and objects Ranger lets you read.
      operationId: list_objects_api_storage_buckets__bucket__objects_get
      parameters:
        - name: bucket
          in: path
          required: true
          schema:
            type: string
            title: Bucket
        - name: prefix
          in: query
          required: false
          schema:
            type: string
            maxLength: 1024
            description: The folder, e.g. raw/2026/.
            default: ''
            title: Prefix
          description: The folder, e.g. raw/2026/.
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 2048
              - type: 'null'
            description: next_cursor from the previous page.
            title: Cursor
          description: next_cursor from the previous page.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectListing'
        '403':
          description: 'The general PSK or a schedule: browse as a person.'
        '404':
          description: Not found, or not yours to read (they look the same).
        '422':
          description: Not a valid bucket, path or format.
        '502':
          description: Storage couldn't be read.
        '503':
          description: 'Ranger''s evaluator is unavailable: nothing is shown.'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    ObjectListing:
      properties:
        bucket:
          type: string
          title: Bucket
        prefix:
          type: string
          title: Prefix
        folders:
          items:
            $ref: '#/components/schemas/FolderEntry'
          type: array
          title: Folders
        objects:
          items:
            $ref: '#/components/schemas/ObjectEntry'
          type: array
          title: Objects
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
      type: object
      required:
        - bucket
        - prefix
        - folders
        - objects
      title: ObjectListing
    FolderEntry:
      properties:
        name:
          type: string
          title: Name
        prefix:
          type: string
          title: Prefix
      type: object
      required:
        - name
        - prefix
      title: FolderEntry
    ObjectEntry:
      properties:
        name:
          type: string
          title: Name
        key:
          type: string
          title: Key
        size:
          type: integer
          title: Size
        modified:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Modified
        content_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Content Type
      type: object
      required:
        - name
        - key
        - size
      title: ObjectEntry
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.