XSKY client-groups API

ClientGroupController Operations about client group

Operations 5

GET /client-groups/ #
POST /client-groups/ #
GET /client-groups/{client_group_id} #
DELETE /client-groups/{client_group_id} #
PATCH /client-groups/{client_group_id} #

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-client-groups-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-client-groups-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 Client Groups API
  contact: {}
  license:
    name: Commercial
servers:
- url: /v1
tags:
- name: client-groups
  description: 'ClientGroupController Operations about client group

    '
paths:
  /client-groups/:
    get:
      tags:
      - client-groups
      description: List client groups
      operationId: ListClientGroups
      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: block_volume_id
        in: query
        description: related block volume id
        required: false
        x-exportParamName: BlockVolumeId
        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/ClientGroupsResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    post:
      tags:
      - client-groups
      description: Create a client group
      operationId: CreateClientGroup
      responses:
        201:
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientGroupResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientGroupCreateReq'
        description: client group info
        required: true
  /client-groups/{client_group_id}:
    get:
      tags:
      - client-groups
      description: get a client group
      operationId: GetClientGroup
      parameters:
      - name: client_group_id
        in: path
        description: client group id
        required: true
        x-exportParamName: ClientGroupId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientGroupResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    delete:
      tags:
      - client-groups
      description: Delete a client
      operationId: DeleteClientGroup
      parameters:
      - name: client_group_id
        in: path
        description: client group id
        required: true
        x-exportParamName: ClientGroupId
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: No Content
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    patch:
      tags:
      - client-groups
      description: update client group
      operationId: UpdateClientGroup
      parameters:
      - name: client_group_id
        in: path
        description: client group id
        required: true
        x-exportParamName: ClientGroupId
        schema:
          type: integer
          format: int64
      responses:
        201:
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientGroupResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientGroupUpdateReq'
        description: client group info
        required: true
components:
  schemas:
    ClientGroup:
      type: object
      properties:
        access_path_num:
          type: integer
          format: int64
        block_volume_num:
          type: integer
          format: int64
        chap:
          type: boolean
        client_num:
          type: integer
          format: int64
        clients:
          type: array
          items:
            $ref: '#/components/schemas/Client'
        create:
          type: string
          format: date-time
        description:
          type: string
        id:
          type: integer
          format: int64
        iname:
          type: string
        isecret:
          type: string
        name:
          type: string
        status:
          type: string
        type:
          type: string
        update:
          type: string
          format: date-time
      title: ClientGroup
      description: ClientGroup defines the access client group
      example:
        clients:
        - code: code
          client_group:
            name: name
            id: 5
          create: '2000-01-23T04:56:07.000+00:00'
          update: '2000-01-23T04:56:07.000+00:00'
          id: 5
          status: status
        - code: code
          client_group:
            name: name
            id: 5
          create: '2000-01-23T04:56:07.000+00:00'
          update: '2000-01-23T04:56:07.000+00:00'
          id: 5
          status: status
        block_volume_num: 6
        access_path_num: 0
        client_num: 1
        description: description
        update: '2000-01-23T04:56:07.000+00:00'
        type: type
        iname: iname
        isecret: isecret
        name: name
        create: '2000-01-23T04:56:07.000+00:00'
        chap: true
        id: 2
        status: status
    ClientGroupsResp:
      type: object
      required:
      - client_groups
      properties:
        client_groups:
          type: array
          description: client groups
          items:
            $ref: '#/components/schemas/ClientGroup'
      title: ClientGroupsResp
      example:
        client_groups:
        - clients:
          - code: code
            client_group:
              name: name
              id: 5
            create: '2000-01-23T04:56:07.000+00:00'
            update: '2000-01-23T04:56:07.000+00:00'
            id: 5
            status: status
          - code: code
            client_group:
              name: name
              id: 5
            create: '2000-01-23T04:56:07.000+00:00'
            update: '2000-01-23T04:56:07.000+00:00'
            id: 5
            status: status
          block_volume_num: 6
          access_path_num: 0
          client_num: 1
          description: description
          update: '2000-01-23T04:56:07.000+00:00'
          type: type
          iname: iname
          isecret: isecret
          name: name
          create: '2000-01-23T04:56:07.000+00:00'
          chap: true
          id: 2
          status: status
        - clients:
          - code: code
            client_group:
              name: name
              id: 5
            create: '2000-01-23T04:56:07.000+00:00'
            update: '2000-01-23T04:56:07.000+00:00'
            id: 5
            status: status
          - code: code
            client_group:
              name: name
              id: 5
            create: '2000-01-23T04:56:07.000+00:00'
            update: '2000-01-23T04:56:07.000+00:00'
            id: 5
            status: status
          block_volume_num: 6
          access_path_num: 0
          client_num: 1
          description: description
          update: '2000-01-23T04:56:07.000+00:00'
          type: type
          iname: iname
          isecret: isecret
          name: name
          create: '2000-01-23T04:56:07.000+00:00'
          chap: true
          id: 2
          status: status
    ClientGroupUpdateReq:
      type: object
      properties:
        client_group:
          $ref: '#/components/schemas/ClientGroupUpdateReq_ClientGroup'
      title: ClientGroupUpdateReq
      example:
        client_group:
          clients:
          - code: code
          - code: code
          name: name
          description: description
    ClientGroupResp:
      type: object
      required:
      - client_group
      properties:
        client_group:
          description: client group
          $ref: '#/components/schemas/ClientGroup'
      title: ClientGroupResp
      example:
        client_group:
          clients:
          - code: code
            client_group:
              name: name
              id: 5
            create: '2000-01-23T04:56:07.000+00:00'
            update: '2000-01-23T04:56:07.000+00:00'
            id: 5
            status: status
          - code: code
            client_group:
              name: name
              id: 5
            create: '2000-01-23T04:56:07.000+00:00'
            update: '2000-01-23T04:56:07.000+00:00'
            id: 5
            status: status
          block_volume_num: 6
          access_path_num: 0
          client_num: 1
          description: description
          update: '2000-01-23T04:56:07.000+00:00'
          type: type
          iname: iname
          isecret: isecret
          name: name
          create: '2000-01-23T04:56:07.000+00:00'
          chap: true
          id: 2
          status: status
    ClientGroupUpdateReq_ClientGroup_Clients_Elt:
      type: object
      properties:
        code:
          type: string
      title: ClientGroupUpdateReq_ClientGroup_Clients_Elt
      example:
        code: code
    Client:
      type: object
      properties:
        client_group:
          $ref: '#/components/schemas/ClientGroup_Nestview'
        code:
          type: string
        create:
          type: string
          format: date-time
        id:
          type: integer
          format: int64
        status:
          type: string
        update:
          type: string
          format: date-time
      title: Client
      example:
        code: code
        client_group:
          name: name
          id: 5
        create: '2000-01-23T04:56:07.000+00:00'
        update: '2000-01-23T04:56:07.000+00:00'
        id: 5
        status: status
    ClientGroupCreateReq_ClientGroup:
      type: object
      properties:
        chap:
          type: boolean
        clients:
          type: array
          items:
            $ref: '#/components/schemas/ClientGroupCreateReq_ClientGroup_Clients_Elt'
        description:
          type: string
        iname:
          type: string
        isecret:
          type: string
        name:
          type: string
        type:
          type: string
      title: ClientGroupCreateReq_ClientGroup
      example:
        isecret: isecret
        clients:
        - code: code
        - code: code
        name: name
        description: description
        chap: true
        type: type
        iname: iname
    ClientGroupUpdateReq_ClientGroup:
      type: object
      properties:
        clients:
          type: array
          items:
            $ref: '#/components/schemas/ClientGroupUpdateReq_ClientGroup_Clients_Elt'
        description:
          type: string
        name:
          type: string
      title: ClientGroupUpdateReq_ClientGroup
      example:
        clients:
        - code: code
        - code: code
        name: name
        description: description
    ClientGroupCreateReq_ClientGroup_Clients_Elt:
      type: object
      properties:
        code:
          type: string
      title: ClientGroupCreateReq_ClientGroup_Clients_Elt
      example:
        code: code
    ClientGroup_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
      title: ClientGroup_Nestview
      example:
        name: name
        id: 5
    ClientGroupCreateReq:
      type: object
      properties:
        client_group:
          $ref: '#/components/schemas/ClientGroupCreateReq_ClientGroup'
      title: ClientGroupCreateReq
      example:
        client_group:
          isecret: isecret
          clients:
          - code: code
          - code: code
          name: name
          description: description
          chap: true
          type: type
          iname: iname
  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