XSKY fs-smb-shares API

FSSMBShareController provides API for fs smb share

Operations 8

GET /fs-smb-shares/ #
POST /fs-smb-shares/ #
GET /fs-smb-shares/{fs_smb_share_id} #
DELETE /fs-smb-shares/{fs_smb_share_id} #
PATCH /fs-smb-shares/{fs_smb_share_id} #
POST /fs-smb-shares/{fs_smb_share_id}:add-acls #
POST /fs-smb-shares/{fs_smb_share_id}:remove-acls #
POST /fs-smb-shares/{fs_smb_share_id}:update-acls #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/xsky-fs-smb-shares-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.

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

OpenAPI Specification

xsky-fs-smb-shares-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: XMS is the controller of distributed storage system
  version: SDS_4.2.000.0.200302
  title: XMS access-paths Fs Smb Shares API
  contact: {}
  license:
    name: Commercial
servers:
- url: /v1
tags:
- name: fs-smb-shares
  description: 'FSSMBShareController provides API for fs smb share

    '
paths:
  /fs-smb-shares/:
    get:
      tags:
      - fs-smb-shares
      description: List fs smb shares
      operationId: ListFSSMBShares
      parameters:
      - name: limit
        in: query
        description: paging param
        required: false
        x-exportParamName: Limit
        schema:
          type: integer
          format: int64
      - name: offset
        in: query
        description: paging param
        required: false
        x-exportParamName: Offset
        schema:
          type: integer
          format: int64
      - name: fs_folder_id
        in: query
        description: fs folder id
        required: false
        x-exportParamName: FsFolderId
        schema:
          type: integer
          format: int64
      - name: fs_gateway_group_id
        in: query
        description: fs gateway group id
        required: false
        x-exportParamName: FsGatewayGroupId
        schema:
          type: integer
          format: int64
      - name: q
        in: query
        description: query param of search
        required: false
        x-exportParamName: Q
        schema:
          type: string
      - name: sort
        in: query
        description: sort param of search
        required: false
        x-exportParamName: Sort
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSSMBSharesResp'
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    post:
      tags:
      - fs-smb-shares
      description: Create fs smb share
      operationId: CreateFSSMBShare
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSSMBShareResp'
        400:
          description: BadRequest
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FSSMBShareCreateReq'
        description: share info
        required: true
  /fs-smb-shares/{fs_smb_share_id}:
    get:
      tags:
      - fs-smb-shares
      description: Get fs smb share
      operationId: GetFSSMBShare
      parameters:
      - name: fs_smb_share_id
        in: path
        description: share id
        required: true
        x-exportParamName: FsSmbShareId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSSMBShareResp'
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    delete:
      tags:
      - fs-smb-shares
      description: delete fs smb share
      operationId: DeleteFSSMBShare
      parameters:
      - name: fs_smb_share_id
        in: path
        description: share id
        required: true
        x-exportParamName: FsSmbShareId
        schema:
          type: integer
          format: int64
      - name: force
        in: query
        description: force delete or not
        required: false
        x-exportParamName: Force
        schema:
          type: boolean
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSSMBShareResp'
        404:
          description: NotFound
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    patch:
      tags:
      - fs-smb-shares
      description: Update fs smb share
      operationId: UpdateFSSMBShare
      parameters:
      - name: fs_smb_share_id
        in: path
        description: share id
        required: true
        x-exportParamName: FsSmbShareId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSSMBShareResp'
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSSMBShareResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FSSMBShareUpdateReq'
        description: share info
        required: true
  /fs-smb-shares/{fs_smb_share_id}:add-acls:
    post:
      tags:
      - fs-smb-shares
      description: Add fs smb share acls
      operationId: AddFSSMBShareACLs
      parameters:
      - name: fs_smb_share_id
        in: path
        description: fs smb share id
        required: true
        x-exportParamName: FsSmbShareId
        schema:
          type: integer
          format: int64
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSSMBShareResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInHeader: []
      - tokenInQuery: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FSSMBShareAddACLsReq'
        description: share acls info
        required: true
  /fs-smb-shares/{fs_smb_share_id}:remove-acls:
    post:
      tags:
      - fs-smb-shares
      description: remove fs smb share acls
      operationId: RemoveFSSMBShareACLs
      parameters:
      - name: fs_smb_share_id
        in: path
        description: fs smb share id
        required: true
        x-exportParamName: FsSmbShareId
        schema:
          type: integer
          format: int64
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSSMBShareResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FSSMBShareRemoveACLsReq'
        description: share acls info
        required: true
  /fs-smb-shares/{fs_smb_share_id}:update-acls:
    post:
      tags:
      - fs-smb-shares
      description: Update fs smb share ACL
      operationId: UpdateFSSMBShareACLs
      parameters:
      - name: fs_smb_share_id
        in: path
        description: share id
        required: true
        x-exportParamName: FsSmbShareId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSSMBShareResp'
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FSSMBShareResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FSSMBShareUpdateACLsReq'
        description: share acls info
        required: true
components:
  schemas:
    FSSMBShareRemoveACLsReq_Share:
      type: object
      required:
      - fs_smb_share_acl_ids
      properties:
        fs_smb_share_acl_ids:
          type: array
          description: access control array
          items:
            type: integer
            format: int64
      title: FSSMBShareRemoveACLsReq_Share
    FSSMBShareACLReq:
      type: object
      properties:
        fs_user_group_id:
          type: integer
          format: int64
          description: id of user group
        fs_user_group_name:
          type: string
          description: id of user group
        fs_user_id:
          type: integer
          format: int64
          description: id of user
        fs_user_name:
          type: string
          description: id of user
        id:
          type: integer
          format: int64
          description: id of user group
        permission:
          type: string
          description: readonly or readwrite access
        type:
          type: string
          description: type of share acl
      title: FSSMBShareACLReq
    FSSMBShareCreateReq_Share:
      type: object
      required:
      - fs_folder_id
      - fs_gateway_group_id
      properties:
        acl_inherited:
          type: boolean
          description: default acl status
        case_sensitive:
          type: boolean
          description: case sensitive
        fs_folder_id:
          type: integer
          format: int64
          description: folder id
        fs_gateway_group_id:
          type: integer
          format: int64
          description: gateway group id
        fs_quota_tree_id:
          type: integer
          format: int64
          description: quota tree id
        fs_smb_share_acls:
          type: array
          description: access control array
          items:
            $ref: '#/components/schemas/FSSMBShareACLReq'
        name:
          type: string
          description: name of share
        recycled:
          type: boolean
          description: recycle status
      title: FSSMBShareCreateReq_Share
    FSSMBShareUpdateACLsReq_Share:
      type: object
      properties:
        fs_smb_share_acls:
          type: array
          description: access control array
          items:
            $ref: '#/components/schemas/FSSMBShareUpdateACLReq'
      title: FSSMBShareUpdateACLsReq_Share
    FSSMBShareUpdateACLReq:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: id of user group
        permission:
          type: string
          description: readonly or readwrite access
      title: FSSMBShareUpdateACLReq
    FSSMBShareRemoveACLsReq:
      type: object
      required:
      - fs_smb_share
      properties:
        fs_smb_share:
          $ref: '#/components/schemas/FSSMBShareRemoveACLsReq_Share'
      title: FSSMBShareRemoveACLsReq
    FSSMBShareResp:
      type: object
      required:
      - fs_smb_share
      properties:
        fs_smb_share:
          description: fs smb share
          $ref: '#/components/schemas/FSSMBShare'
      title: FSSMBShareResp
      example:
        fs_smb_share:
          acl_inherited: true
          fs_quota_tree:
            name: name
            id: 5
          update: '2000-01-23T04:56:07.000+00:00'
          security: security
          recycled: true
          mapping_num: 1
          case_sensitive: true
          fs_folder:
            name: name
            id: 6
          name: name
          create: '2000-01-23T04:56:07.000+00:00'
          acl_num: 0
          id: 6
          fs_gateway_group:
            name: name
            id: 6
            vip_mask: 1
            vip: vip
          action_status: action_status
          status: status
    FSSMBShareAddACLsReq_Share:
      type: object
      required:
      - fs_smb_share_acls
      properties:
        fs_smb_share_acls:
          type: array
          description: access control array
          items:
            $ref: '#/components/schemas/FSSMBShareACLReq'
      title: FSSMBShareAddACLsReq_Share
    FSSMBSharesResp:
      type: object
      required:
      - fs_smb_shares
      properties:
        fs_smb_shares:
          type: array
          description: fs smb shares
          items:
            $ref: '#/components/schemas/FSSMBShare'
      title: FSSMBSharesResp
      example:
        fs_smb_shares:
        - acl_inherited: true
          fs_quota_tree:
            name: name
            id: 5
          update: '2000-01-23T04:56:07.000+00:00'
          security: security
          recycled: true
          mapping_num: 1
          case_sensitive: true
          fs_folder:
            name: name
            id: 6
          name: name
          create: '2000-01-23T04:56:07.000+00:00'
          acl_num: 0
          id: 6
          fs_gateway_group:
            name: name
            id: 6
            vip_mask: 1
            vip: vip
          action_status: action_status
          status: status
        - acl_inherited: true
          fs_quota_tree:
            name: name
            id: 5
          update: '2000-01-23T04:56:07.000+00:00'
          security: security
          recycled: true
          mapping_num: 1
          case_sensitive: true
          fs_folder:
            name: name
            id: 6
          name: name
          create: '2000-01-23T04:56:07.000+00:00'
          acl_num: 0
          id: 6
          fs_gateway_group:
            name: name
            id: 6
            vip_mask: 1
            vip: vip
          action_status: action_status
          status: status
    FSQuotaTree_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
      title: FSQuotaTree_Nestview
      example:
        name: name
        id: 5
    FSSMBShareUpdateACLsReq:
      type: object
      required:
      - fs_smb_share
      properties:
        fs_smb_share:
          $ref: '#/components/schemas/FSSMBShareUpdateACLsReq_Share'
      title: FSSMBShareUpdateACLsReq
    FSSMBShare:
      type: object
      properties:
        acl_inherited:
          type: boolean
        acl_num:
          type: integer
          format: int64
        action_status:
          type: string
        case_sensitive:
          type: boolean
        create:
          type: string
          format: date-time
        fs_folder:
          $ref: '#/components/schemas/FSFolder_Nestview'
        fs_gateway_group:
          $ref: '#/components/schemas/FSGatewayGroup_Nestview'
        fs_quota_tree:
          $ref: '#/components/schemas/FSQuotaTree_Nestview'
        id:
          type: integer
          format: int64
        mapping_num:
          type: integer
          format: int64
        name:
          type: string
        recycled:
          type: boolean
        security:
          type: string
        status:
          type: string
        update:
          type: string
          format: date-time
      title: FSSMBShare
      description: FSSMBShare defines model of fs smb share
      example:
        acl_inherited: true
        fs_quota_tree:
          name: name
          id: 5
        update: '2000-01-23T04:56:07.000+00:00'
        security: security
        recycled: true
        mapping_num: 1
        case_sensitive: true
        fs_folder:
          name: name
          id: 6
        name: name
        create: '2000-01-23T04:56:07.000+00:00'
        acl_num: 0
        id: 6
        fs_gateway_group:
          name: name
          id: 6
          vip_mask: 1
          vip: vip
        action_status: action_status
        status: status
    FSFolder_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
      title: FSFolder_Nestview
      example:
        name: name
        id: 6
    FSSMBShareAddACLsReq:
      type: object
      required:
      - fs_smb_share
      properties:
        fs_smb_share:
          $ref: '#/components/schemas/FSSMBShareAddACLsReq_Share'
      title: FSSMBShareAddACLsReq
    FSSMBShareCreateReq:
      type: object
      required:
      - fs_smb_share
      properties:
        fs_smb_share:
          $ref: '#/components/schemas/FSSMBShareCreateReq_Share'
      title: FSSMBShareCreateReq
    FSSMBShareUpdateReq:
      type: object
      required:
      - fs_smb_share
      properties:
        fs_smb_share:
          $ref: '#/components/schemas/FSSMBShareUpdateReq_Share'
      title: FSSMBShareUpdateReq
    FSSMBShareUpdateReq_Share:
      type: object
      properties:
        acl_inherited:
          type: boolean
          description: default acl status
        case_sensitive:
          type: boolean
          description: case sensitive
        recycled:
          type: boolean
          description: recycle status
      title: FSSMBShareUpdateReq_Share
    FSGatewayGroup_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        vip:
          type: string
        vip_mask:
          type: integer
          format: int64
      title: FSGatewayGroup_Nestview
      example:
        name: name
        id: 6
        vip_mask: 1
        vip: vip
  securitySchemes:
    tokenInHeader:
      description: auth by token
      type: apiKey
      name: Xms-Auth-Token
      in: header
    tokenInQuery:
      description: auth by token
      type: apiKey
      name: token
      in: query