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

# Registered buckets

> Every registered bucket with its endpoint host, whether it answers
(HeadBucket with its stored keys, 3 s timeout, cached 60 s) and what you
can do in it (read or write the whole bucket, some of it, or nothing).
Never a key.



## OpenAPI

````yaml get /api/storage/buckets
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:
    get:
      tags:
        - Object storage
      summary: Registered buckets
      description: |-
        Every registered bucket with its endpoint host, whether it answers
        (HeadBucket with its stored keys, 3 s timeout, cached 60 s) and what you
        can do in it (read or write the whole bucket, some of it, or nothing).
        Never a key.
      operationId: list_buckets_api_storage_buckets_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BucketSummary'
                type: array
                title: Response List Buckets Api Storage Buckets Get
        '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:
    BucketSummary:
      properties:
        bucket:
          type: string
          title: Bucket
        endpoint_host:
          type: string
          title: Endpoint Host
          description: host[:port] of the bucket's endpoint.
        reachable:
          $ref: '#/components/schemas/Reachable'
          description: HeadBucket with the stored keys (3 s timeout, cached 60 s).
        checked_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Checked At
        you_can:
          $ref: '#/components/schemas/YouCan'
          description: 'write/read: the whole bucket; some: part of it; none.'
        registered:
          type: boolean
          title: Registered
          description: >-
            False for a bucket you can read in that nobody registered (it uses
            the platform's default credentials).
          default: true
        credentials_configured:
          type: boolean
          title: Credentials Configured
          description: Whether the registration has an endpoint and both keys.
      type: object
      required:
        - bucket
        - endpoint_host
        - reachable
        - you_can
        - credentials_configured
      title: BucketSummary
    Reachable:
      type: string
      enum:
        - up
        - down
        - unknown
      title: Reachable
    YouCan:
      type: string
      enum:
        - read
        - write
        - some
        - none
      title: YouCan
  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.