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

# Test a bucket's connection

> Admin: HeadBucket against the endpoint with these keys. With no
secret, an existing bucket's stored one is used (same access key only).
Answers ok, or a fixed reason; never a key.



## OpenAPI

````yaml post /api/storage/buckets/test
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/test:
    post:
      tags:
        - Object storage
      summary: Test a bucket's connection
      description: |-
        Admin: HeadBucket against the endpoint with these keys. With no
        secret, an existing bucket's stored one is used (same access key only).
        Answers ok, or a fixed reason; never a key.
      operationId: check_bucket_connection_api_storage_buckets_test_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionTestRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionTestResponse'
        '400':
          description: Invalid bucket, endpoint or keys.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    ConnectionTestRequest:
      properties:
        bucket:
          type: string
          maxLength: 63
          minLength: 3
          title: Bucket
        endpoint:
          type: string
          maxLength: 500
          title: Endpoint
        accesskey:
          anyOf:
            - type: string
            - type: 'null'
          title: Accesskey
          description: Omit to use the stored access key of an existing bucket.
        secretkey:
          anyOf:
            - type: string
              format: password
              writeOnly: true
            - type: 'null'
          title: Secretkey
          description: >-
            Omit to use the stored secret of an existing bucket with the same
            access key.
      type: object
      required:
        - bucket
        - endpoint
      title: ConnectionTestRequest
      description: |-
        Keys are unconstrained here on purpose: a validation error echoes its
        input, so their lengths are checked in the service, with fixed messages.
    ConnectionTestResponse:
      properties:
        ok:
          type: boolean
          title: Ok
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
          description: A fixed reason when not ok.
      type: object
      required:
        - ok
      title: ConnectionTestResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  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.