XSKY os-keys API

ObjectStorageKeyController provides API for object storage key

Operations 5

GET /os-keys/ #
POST /os-keys/ #
GET /os-keys/{key_id} #
DELETE /os-keys/{key_id} #
PATCH /os-keys/{key_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-os-keys-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-os-keys-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 Os Keys API
  contact: {}
  license:
    name: Commercial
servers:
- url: /v1
tags:
- name: os-keys
  description: 'ObjectStorageKeyController provides API for object storage key

    '
paths:
  /os-keys/:
    get:
      tags:
      - os-keys
      description: List object storage keys
      operationId: ListKeys
      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: user_id
        in: query
        description: object storage user id
        required: false
        x-exportParamName: UserId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectStorageKeysResp'
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    post:
      tags:
      - os-keys
      description: Create new object storage key
      operationId: CreateKey
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectStorageKeyResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObjectStorageKeyCreateReq'
        description: key info
        required: true
  /os-keys/{key_id}:
    get:
      tags:
      - os-keys
      description: get object storage key
      operationId: GetKey
      parameters:
      - name: key_id
        in: path
        description: user id
        required: true
        x-exportParamName: KeyId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectStorageKeyResp'
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    delete:
      tags:
      - os-keys
      description: Delete object storage key
      operationId: DeleteKey
      parameters:
      - name: key_id
        in: path
        description: key id
        required: true
        x-exportParamName: KeyId
        schema:
          type: integer
          format: int64
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectStorageKeyResp'
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    patch:
      tags:
      - os-keys
      description: Update object storage key
      operationId: UpdateKey
      parameters:
      - name: key_id
        in: path
        description: key id
        required: true
        x-exportParamName: KeyId
        schema:
          type: integer
          format: int64
      responses:
        202:
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectStorageKeyResp'
        404:
          description: NotFound
        409:
          description: Conflict
        500:
          description: InternalServerError
      security:
      - tokenInHeader: []
      - tokenInQuery: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObjectStorageKeyUpdateReq'
        description: key info
        required: true
components:
  schemas:
    ObjectStorageKeyCreateReq:
      type: object
      properties:
        os_key:
          $ref: '#/components/schemas/ObjectStorageKeyCreateReq_Key'
      title: ObjectStorageKeyCreateReq
      example:
        os_key:
          secret_key: secret_key
          user_id: 0
          access_key: access_key
    ObjectStorageUser_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
      title: ObjectStorageUser_Nestview
      example:
        name: name
        id: 1
    ObjectStorageKeysResp:
      type: object
      required:
      - os_keys
      properties:
        os_keys:
          type: array
          description: object storage keys
          items:
            $ref: '#/components/schemas/ObjectStorageKey'
      title: ObjectStorageKeysResp
      example:
        os_keys:
        - secret_key: secret_key
          reserved: true
          access_key: access_key
          create: '2000-01-23T04:56:07.000+00:00'
          update: '2000-01-23T04:56:07.000+00:00'
          id: 0
          type: type
          user:
            name: name
            id: 1
          status: status
        - secret_key: secret_key
          reserved: true
          access_key: access_key
          create: '2000-01-23T04:56:07.000+00:00'
          update: '2000-01-23T04:56:07.000+00:00'
          id: 0
          type: type
          user:
            name: name
            id: 1
          status: status
    ObjectStorageKeyResp:
      type: object
      required:
      - os_key
      properties:
        os_key:
          description: object storage key
          $ref: '#/components/schemas/ObjectStorageKey'
      title: ObjectStorageKeyResp
      example:
        os_key:
          secret_key: secret_key
          reserved: true
          access_key: access_key
          create: '2000-01-23T04:56:07.000+00:00'
          update: '2000-01-23T04:56:07.000+00:00'
          id: 0
          type: type
          user:
            name: name
            id: 1
          status: status
    ObjectStorageKey:
      type: object
      properties:
        access_key:
          type: string
        create:
          type: string
          format: date-time
        id:
          type: integer
          format: int64
        reserved:
          type: boolean
        secret_key:
          type: string
        status:
          type: string
        type:
          type: string
        update:
          type: string
          format: date-time
        user:
          $ref: '#/components/schemas/ObjectStorageUser_Nestview'
      title: ObjectStorageKey
      description: ObjectStorageKey defines access key and secret key for object storage
      example:
        secret_key: secret_key
        reserved: true
        access_key: access_key
        create: '2000-01-23T04:56:07.000+00:00'
        update: '2000-01-23T04:56:07.000+00:00'
        id: 0
        type: type
        user:
          name: name
          id: 1
        status: status
    ObjectStorageKeyUpdateReq_Key:
      type: object
      properties:
        secret_key:
          type: string
      title: ObjectStorageKeyUpdateReq_Key
      example:
        secret_key: secret_key
    ObjectStorageKeyUpdateReq:
      type: object
      properties:
        os_key:
          $ref: '#/components/schemas/ObjectStorageKeyUpdateReq_Key'
      title: ObjectStorageKeyUpdateReq
      example:
        os_key:
          secret_key: secret_key
    ObjectStorageKeyCreateReq_Key:
      type: object
      required:
      - access_key
      - user_id
      properties:
        access_key:
          type: string
        secret_key:
          type: string
        user_id:
          type: integer
          format: int64
      title: ObjectStorageKeyCreateReq_Key
      example:
        secret_key: secret_key
        user_id: 0
        access_key: access_key
  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