find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/antfly:antfly-user-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Antfly Public User API
  version: v1alpha1
  description: Joined public contract for the Antfly server. Antfly APIs are served under `/db/v1`, auth APIs under `/auth/v1`, inference APIs under `/ai/v1`, ML prediction APIs under `/ml/v1`, and extension lifecycle APIs under `/extensions/v1`.
servers:
- url: /
security:
- BasicAuth: []
- ApiKeyAuth: []
- BearerAuth: []
tags:
- name: User
  x-displayName: User
  description: Operations related to users
paths:
  /auth/v1/me:
    get:
      tags:
      - User
      summary: Get current authenticated user
      description: Retrieves details for the currently authenticated user.
      operationId: getCurrentUser
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  username:
                    type: string
                    example: johndoe
                  permissions:
                    type: array
                    items:
                      $ref: '#/components/schemas/Permission'
                  metadata:
                    type:
                    - object
                    - 'null'
                    additionalProperties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      - BearerAuth: []
  /auth/v1/users:
    get:
      tags:
      - User
      summary: List all users
      description: Retrieves a list of all users in the system. Requires admin permission.
      operationId: listUsers
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    username:
                      type: string
                      example: johndoe
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - requires admin permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      - BearerAuth: []
  /auth/v1/users/{userName}:
    parameters:
    - $ref: '#/components/parameters/UserNamePathParameter'
    post:
      tags:
      - User
      summary: Create a new user
      description: Creates a new user with the given username and password. Username in path takes precedence.
      operationId: createUser
      requestBody:
        description: User creation details
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserRequest'
      responses:
        '201':
          description: User created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '400':
          description: Bad Request (e.g., invalid input, username/password mismatch)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict (e.g., user already exists)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      - BearerAuth: []
    get:
      tags:
      - User
      summary: Get user details
      description: Retrieves details for a specific user.
      operationId: getUserByName
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '400':
          description: Bad Request (e.g., username is required)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      - BearerAuth: []
    delete:
      tags:
      - User
      summary: Delete a user
      description: Deletes a specific user.
      operationId: deleteUser
      responses:
        '204':
          description: User deleted successfully
        '400':
          description: Bad Request (e.g., username is required)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      - BearerAuth: []
  /auth/v1/users/{userName}/password:
    parameters:
    - $ref: '#/components/parameters/UserNamePathParameter'
    put:
      tags:
      - User
      summary: Update user password
      description: Updates the password for a specific user.
      operationId: updateUserPassword
      requestBody:
        description: New password details
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePasswordRequest'
      responses:
        '200':
          description: Password updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessMessage'
        '400':
          description: Bad Request (e.g., new password empty, username required)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      - BearerAuth: []
components:
  schemas:
    User:
      type: object
      properties:
        username:
          type: string
          example: johndoe
        password_hash:
          type: string
          format: byte
          description: Base64 encoded password hash. Exposing this is a security risk.
          example: JGFyZ29uMm...
        metadata:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: Server-side auth metadata available to stored row-filter policies through $auth metadata paths.
          example:
            tenant_id: acme
            department: eng
      required:
      - username
      - password_hash
    Permission:
      type: object
      description: Specify exactly one of a legacy literal resource or a structured table_target; table_target requires resource_type table.
      properties:
        resource:
          type: string
          description: Resource name (e.g., table name, target username, or '*' for all inference operations or a global grant).
          example: orders_table
        table_target:
          $ref: '#/components/schemas/CatalogTableScope'
        resource_type:
          $ref: '#/components/schemas/ResourceType'
        type:
          $ref: '#/components/schemas/PermissionType'
      required:
      - resource_type
      - type
    SuccessMessage:
      type: object
      properties:
        message:
          type: string
          example: Operation completed successfully
    CatalogTableScope:
      type: object
      description: A table or all tables in an explicit namespace. A missing table selects the namespace; a table named '*' remains literal.
      properties:
        database:
          type: string
          default: default
        namespace:
          type: string
          default: public
        table:
          type: string
      additionalProperties: false
    Error:
      type: object
      properties:
        code:
          type: string
          description: Optional stable machine-readable error code for programmatic handling.
        error:
          type: string
          example: An error message
          description: Legacy human-readable error text.
        message:
          type: string
          description: Human-readable error description when supplied by the endpoint.
        retryable:
          type: boolean
          description: Whether retrying the operation may succeed without changing the request.
        retry_after_ms:
          type: integer
          format: int32
          minimum: 1
          description: Suggested minimum retry delay in milliseconds.
      required:
      - error
    ResourceType:
      type: string
      enum:
      - table
      - database
      - namespace
      - tablespace
      - user
      - inference
      - '*'
      description: 'Type of resource: table, user, inference, or global (''*''). Use inference with resource ''*'' to grant access to unified inference routes.'
      example: table
    PermissionType:
      type: string
      enum:
      - read
      - write
      - curator
      - admin
      description: Type of permission.
      example: read
    UpdatePasswordRequest:
      type: object
      properties:
        new_password:
          type: string
          format: password
          example: newS3cr3tP@sswOrd
      required:
      - new_password
    CreateUserRequest:
      type: object
      properties:
        username:
          type: string
          description: Username for the new user. If provided in the path, this field can be omitted or must match the path parameter.
          example: johndoe
        password:
          type: string
          format: password
          example: s3cr3tP@sswOrd
        initial_policies:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Permission'
          description: Optional list of initial permissions for the user.
        metadata:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: Auth metadata available to stored row-filter policies.
          example:
            tenant_id: acme
      required:
      - password
  parameters:
    UserNamePathParameter:
      name: userName
      in: path
      required: true
      description: The username.
      schema:
        type: string
        example: johndoe
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
    BearerAuth:
      type: http
      scheme: bearer
x-tagGroups:
- name: Antfly
  tags:
  - cluster_management
  - table_management
  - data_operations
  - query_operations
  - index_management
- name: Auth
  tags:
  - User
  - Permission
  - ApiKey
  - RowFilter
- name: Inference
  tags: []
- name: Extensions
  tags:
  - Packages
  - Installed