> ## 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.

# Where you can read

> Your readable (and writable) locations, grouped by bucket, as
``s3://`` urls. Worked out from the storage policies and confirmed one by
one by Ranger's evaluator.



## OpenAPI

````yaml get /api/storage/locations
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/locations:
    get:
      tags:
        - Object storage
      summary: Where you can read
      description: >-
        Your readable (and writable) locations, grouped by bucket, as

        ``s3://`` urls. Worked out from the storage policies and confirmed one
        by

        one by Ranger's evaluator.
      operationId: locations_api_storage_locations_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationsResponse'
        '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:
    LocationsResponse:
      properties:
        buckets:
          items:
            $ref: '#/components/schemas/BucketLocations'
          type: array
          title: Buckets
        super_admin:
          anyOf:
            - type: string
            - type: 'null'
          title: Super Admin
          description: >-
            The super user or group (e.g. trino-admin) that makes the caller a
            super admin: they can read and write every location, so buckets list
            as write whatever the locations say. Null otherwise.
      type: object
      required:
        - buckets
      title: LocationsResponse
    BucketLocations:
      properties:
        bucket:
          type: string
          title: Bucket
        locations:
          items:
            $ref: '#/components/schemas/StorageLocation'
          type: array
          title: Locations
      type: object
      required:
        - bucket
        - locations
      title: BucketLocations
    StorageLocation:
      properties:
        url:
          type: string
          title: Url
          description: s3://bucket/prefix/
        prefix:
          type: string
          title: Prefix
          description: The folder ('' is the bucket).
        write:
          type: boolean
          title: Write
          default: false
      type: object
      required:
        - url
        - prefix
      title: StorageLocation
  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.