openapi: 3.2.0
info:
  title: Nasuni Index API
  version: '1.0'
  description: 'Operations tagged Index across 3 of this provider''s published API definitions: nasuni-nmc-v1-0-openapi.yml, nasuni-nmc-v1-1-openapi.yml, nasuni-nmc-v1-2-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://hostname/api/v1
- url: https://hostname/api/v1.1
- url: https://hostname/api/v1.2
security:
- AuthToken: []
tags:
- name: Index
paths:
  /:
    get:
      tags:
      - Index
      summary: View top-level endpoints
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  auth:
                    type: string
                    description: A link to the authentication resource.
                  volumes:
                    type: string
                    description: A link to the volumes resource.
                  filers:
                    type: string
                    description: A link to the filers resource.
                  messages:
                    type: string
                    description: A link to the messages resource.
                  notifications:
                    type: string
                    description: A link to the notifications resource.
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://hostname/api/v1
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          description: 'Specifies the type of error reported. Possible values:


            * "error" - General error

            * "validation_error" - Validation error

            * "not_found_error" - Resource not found

            * "auth_error" - Authentication error

            * "perm_error" - Permission error

            * "sync_error" - Error occurred syncing settings with a Filer.

            * "throttled_error" - The request was throttled; too many sent within a duration.

            '
          enum:
          - error
          - validation_error
          - not_found_error
          - auth_error
          - perm_error
          - sync_error
          - throttled_error
        description:
          type: string
          description: Description of the error reported.
    ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Error_2'
    Error_2:
      type: object
      properties:
        code:
          type: string
          description: 'Specifies the type of error reported. Possible values:


            * "error" - General error

            * "validation_error" - Validation error

            * "not_found_error" - Resource not found

            * "auth_error" - Authentication error

            * "perm_error" - Permission error

            * "sync_error" - Error occurred syncing settings with a Filer.

            * "unmanaged_error" - Resource is not managed.

            * "conflict_error" - Conflict error

            * "unsupported_error" - Current filer version does not support this type of request.

            * "throttled_error" - The request was throttled; too many sent within a duration.

            '
          readOnly: true
          enum:
          - error
          - validation_error
          - not_found_error
          - auth_error
          - perm_error
          - sync_error
          - unmanaged_error
          - conflict_error
          - unsupported_error
          - throttled_error
        description:
          type: string
          description: Description of the error reported.
          readOnly: true
    ErrorResponse_2:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Error_3'
    Error_3:
      type: object
      properties:
        code:
          type: string
          description: 'Specifies the type of error reported. Possible values:


            * "error" - General error

            * "validation_error" - Validation error

            * "not_found_error" - Resource not found

            * "auth_error" - Authentication error

            * "perm_error" - Permission error

            * "sync_error" - Error occurred syncing settings with a Filer.

            * "unmanaged_error" - Resource is not managed.

            * "conflict_error" - Conflict error

            * "unsupported_error" - Current filer version does not support this type of request.

            * "throttled_error" - The request was throttled; too many sent within a duration.

            '
          readOnly: true
          enum:
          - error
          - validation_error
          - not_found_error
          - auth_error
          - perm_error
          - sync_error
          - unmanaged_error
          - conflict_error
          - unsupported_error
          - throttled_error
        description:
          type: string
          description: Description of the error reported.
          readOnly: true
  securitySchemes:
    AuthToken:
      type: apiKey
      description: 'This header is required to make authenticated requests. The value format is:


        Token [your_auth_token]

        '
      name: Authorization
      in: header
x-refined-from:
- nasuni-nmc-v1-0-openapi.yml
- nasuni-nmc-v1-1-openapi.yml
- nasuni-nmc-v1-2-openapi.yml