github.com/minio/console@v1.3.0/swagger.yml (about)

     1  # @format
     2  
     3  swagger: "2.0"
     4  info:
     5    title: MinIO Console Server
     6    version: 0.1.0
     7  consumes:
     8    - application/json
     9  produces:
    10    - application/json
    11  schemes:
    12    - http
    13    - ws
    14  basePath: /api/v1
    15  # We are going to be taking `Authorization: Bearer TOKEN` header for our authentication
    16  securityDefinitions:
    17    key:
    18      type: oauth2
    19      flow: accessCode
    20      authorizationUrl: http://min.io
    21      tokenUrl: http://min.io
    22    anonymous:
    23      name: X-Anonymous
    24      in: header
    25      type: apiKey
    26  # Apply the key security definition to all APIs
    27  security:
    28    - key: []
    29  parameters:
    30    limit:
    31      name: limit
    32      in: query
    33      type: number
    34      format: int32
    35      default: 20
    36    offset:
    37      name: offset
    38      in: query
    39      type: number
    40      format: int32
    41      default: 0
    42  paths:
    43    /login:
    44      get:
    45        summary: Returns login strategy, form or sso.
    46        operationId: LoginDetail
    47        responses:
    48          200:
    49            description: A successful response.
    50            schema:
    51              $ref: "#/definitions/loginDetails"
    52          default:
    53            description: Generic error response.
    54            schema:
    55              $ref: "#/definitions/ApiError"
    56        # Exclude this API from the authentication requirement
    57        security: []
    58        tags:
    59          - Auth
    60      post:
    61        summary: Login to Console
    62        operationId: Login
    63        parameters:
    64          - name: body
    65            in: body
    66            required: true
    67            schema:
    68              $ref: "#/definitions/loginRequest"
    69        responses:
    70          204:
    71            description: A successful login.
    72          default:
    73            description: Generic error response.
    74            schema:
    75              $ref: "#/definitions/ApiError"
    76        # Exclude this API from the authentication requirement
    77        security: []
    78        tags:
    79          - Auth
    80    /login/oauth2/auth:
    81      post:
    82        summary: Identity Provider oauth2 callback endpoint.
    83        operationId: LoginOauth2Auth
    84        parameters:
    85          - name: body
    86            in: body
    87            required: true
    88            schema:
    89              $ref: "#/definitions/loginOauth2AuthRequest"
    90        responses:
    91          204:
    92            description: A successful login.
    93          default:
    94            description: Generic error response.
    95            schema:
    96              $ref: "#/definitions/ApiError"
    97        security: []
    98        tags:
    99          - Auth
   100  
   101    /logout:
   102      post:
   103        summary: Logout from Console.
   104        operationId: Logout
   105        parameters:
   106          - name: body
   107            in: body
   108            required: true
   109            schema:
   110              $ref: "#/definitions/logoutRequest"
   111        responses:
   112          200:
   113            description: A successful response.
   114          default:
   115            description: Generic error response.
   116            schema:
   117              $ref: "#/definitions/ApiError"
   118        tags:
   119          - Auth
   120  
   121    /session:
   122      get:
   123        summary: Endpoint to check if your session is still valid
   124        operationId: SessionCheck
   125        responses:
   126          200:
   127            description: A successful response.
   128            schema:
   129              $ref: "#/definitions/sessionResponse"
   130          default:
   131            description: Generic error response.
   132            schema:
   133              $ref: "#/definitions/ApiError"
   134        tags:
   135          - Auth
   136  
   137    /account/change-password:
   138      post:
   139        summary: Change password of currently logged in user.
   140        operationId: AccountChangePassword
   141        parameters:
   142          - name: body
   143            in: body
   144            required: true
   145            schema:
   146              $ref: "#/definitions/accountChangePasswordRequest"
   147        responses:
   148          204:
   149            description: A successful login.
   150          default:
   151            description: Generic error response.
   152            schema:
   153              $ref: "#/definitions/ApiError"
   154        tags:
   155          - Account
   156  
   157    /account/change-user-password:
   158      post:
   159        summary: Change password of currently logged in user.
   160        operationId: ChangeUserPassword
   161        parameters:
   162          - name: body
   163            in: body
   164            required: true
   165            schema:
   166              $ref: "#/definitions/changeUserPasswordRequest"
   167        responses:
   168          201:
   169            description: Password successfully changed.
   170          default:
   171            description: Generic error response.
   172            schema:
   173              $ref: "#/definitions/ApiError"
   174        tags:
   175          - Account
   176  
   177    /buckets:
   178      get:
   179        summary: List Buckets
   180        operationId: ListBuckets
   181        responses:
   182          200:
   183            description: A successful response.
   184            schema:
   185              $ref: "#/definitions/listBucketsResponse"
   186          default:
   187            description: Generic error response.
   188            schema:
   189              $ref: "#/definitions/ApiError"
   190        tags:
   191          - Bucket
   192      post:
   193        summary: Make bucket
   194        operationId: MakeBucket
   195        parameters:
   196          - name: body
   197            in: body
   198            required: true
   199            schema:
   200              $ref: "#/definitions/makeBucketRequest"
   201        responses:
   202          200:
   203            description: A successful response.
   204            schema:
   205              $ref: "#/definitions/makeBucketsResponse"
   206          default:
   207            description: Generic error response.
   208            schema:
   209              $ref: "#/definitions/ApiError"
   210        tags:
   211          - Bucket
   212  
   213    /buckets/{name}:
   214      get:
   215        summary: Bucket Info
   216        operationId: BucketInfo
   217        parameters:
   218          - name: name
   219            in: path
   220            required: true
   221            type: string
   222        responses:
   223          200:
   224            description: A successful response.
   225            schema:
   226              $ref: "#/definitions/bucket"
   227          default:
   228            description: Generic error response.
   229            schema:
   230              $ref: "#/definitions/ApiError"
   231        tags:
   232          - Bucket
   233      delete:
   234        summary: Delete Bucket
   235        operationId: DeleteBucket
   236        parameters:
   237          - name: name
   238            in: path
   239            required: true
   240            type: string
   241        responses:
   242          204:
   243            description: A successful response.
   244          default:
   245            description: Generic error response.
   246            schema:
   247              $ref: "#/definitions/ApiError"
   248        tags:
   249          - Bucket
   250  
   251    /buckets/{bucket_name}/retention:
   252      get:
   253        summary: Get Bucket's retention config
   254        operationId: GetBucketRetentionConfig
   255        parameters:
   256          - name: bucket_name
   257            in: path
   258            required: true
   259            type: string
   260        responses:
   261          200:
   262            description: A successful response.
   263            schema:
   264              $ref: "#/definitions/getBucketRetentionConfig"
   265          default:
   266            description: Generic error response.
   267            schema:
   268              $ref: "#/definitions/ApiError"
   269        tags:
   270          - Bucket
   271      put:
   272        summary: Set Bucket's retention config
   273        operationId: SetBucketRetentionConfig
   274        parameters:
   275          - name: bucket_name
   276            in: path
   277            required: true
   278            type: string
   279          - name: body
   280            in: body
   281            required: true
   282            schema:
   283              $ref: "#/definitions/putBucketRetentionRequest"
   284        responses:
   285          200:
   286            description: A successful response.
   287          default:
   288            description: Generic error response.
   289            schema:
   290              $ref: "#/definitions/ApiError"
   291        tags:
   292          - Bucket
   293  
   294    /buckets/{bucket_name}/objects:
   295      get:
   296        summary: List Objects
   297        security:
   298          - key: []
   299          - anonymous: []
   300        operationId: ListObjects
   301        parameters:
   302          - name: bucket_name
   303            in: path
   304            required: true
   305            type: string
   306          - name: prefix
   307            in: query
   308            required: false
   309            type: string
   310          - name: recursive
   311            in: query
   312            required: false
   313            type: boolean
   314          - name: with_versions
   315            in: query
   316            required: false
   317            type: boolean
   318          - name: with_metadata
   319            in: query
   320            required: false
   321            type: boolean
   322          - $ref: "#/parameters/limit"
   323        responses:
   324          200:
   325            description: A successful response.
   326            schema:
   327              $ref: "#/definitions/listObjectsResponse"
   328          default:
   329            description: Generic error response.
   330            schema:
   331              $ref: "#/definitions/ApiError"
   332        tags:
   333          - Object
   334      delete:
   335        summary: Delete Object
   336        operationId: DeleteObject
   337        parameters:
   338          - name: bucket_name
   339            in: path
   340            required: true
   341            type: string
   342          - name: prefix
   343            in: query
   344            required: true
   345            type: string
   346          - name: version_id
   347            in: query
   348            required: false
   349            type: string
   350          - name: recursive
   351            in: query
   352            required: false
   353            type: boolean
   354          - name: all_versions
   355            in: query
   356            required: false
   357            type: boolean
   358          - name: non_current_versions
   359            in: query
   360            required: false
   361            type: boolean
   362          - name: bypass
   363            in: query
   364            required: false
   365            type: boolean
   366        responses:
   367          200:
   368            description: A successful response.
   369          default:
   370            description: Generic error response.
   371            schema:
   372              $ref: "#/definitions/ApiError"
   373        tags:
   374          - Object
   375  
   376    /buckets/{bucket_name}/delete-objects:
   377      post:
   378        summary: Delete Multiple Objects
   379        operationId: DeleteMultipleObjects
   380        parameters:
   381          - name: bucket_name
   382            in: path
   383            required: true
   384            type: string
   385          - name: all_versions
   386            in: query
   387            required: false
   388            type: boolean
   389          - name: bypass
   390            in: query
   391            required: false
   392            type: boolean
   393          - name: files
   394            in: body
   395            required: true
   396            schema:
   397              type: array
   398              items:
   399                $ref: "#/definitions/deleteFile"
   400        responses:
   401          200:
   402            description: A successful response.
   403          default:
   404            description: Generic error response.
   405            schema:
   406              $ref: "#/definitions/ApiError"
   407        tags:
   408          - Object
   409  
   410    /buckets/{bucket_name}/objects/upload:
   411      post:
   412        summary: Uploads an Object.
   413        security:
   414          - key: []
   415          - anonymous: []
   416        consumes:
   417          - multipart/form-data
   418        parameters:
   419          - name: bucket_name
   420            in: path
   421            required: true
   422            type: string
   423          - name: prefix
   424            in: query
   425            type: string
   426        responses:
   427          200:
   428            description: A successful response.
   429          default:
   430            description: Generic error response.
   431            schema:
   432              $ref: "#/definitions/ApiError"
   433        tags:
   434          - Object
   435  
   436    /buckets/{bucket_name}/objects/download-multiple:
   437      post:
   438        summary: Download Multiple Objects
   439        operationId: DownloadMultipleObjects
   440        security:
   441          - key: []
   442          - anonymous: []
   443        produces:
   444          - application/octet-stream
   445        parameters:
   446          - name: bucket_name
   447            in: path
   448            required: true
   449            type: string
   450          - name: objectList
   451            in: body
   452            required: true
   453            schema:
   454              type: array
   455              items:
   456                type: string
   457        responses:
   458          200:
   459            description: A successful response.
   460            schema:
   461              type: file
   462          default:
   463            description: Generic error response.
   464            schema:
   465              $ref: "#/definitions/ApiError"
   466        tags:
   467          - Object
   468  
   469    /buckets/{bucket_name}/objects/download:
   470      get:
   471        summary: Download Object
   472        operationId: Download Object
   473        security:
   474          - key: []
   475          - anonymous: []
   476        produces:
   477          - application/octet-stream
   478        parameters:
   479          - name: bucket_name
   480            in: path
   481            required: true
   482            type: string
   483          - name: prefix
   484            in: query
   485            required: true
   486            type: string
   487          - name: version_id
   488            in: query
   489            required: false
   490            type: string
   491          - name: preview
   492            in: query
   493            required: false
   494            type: boolean
   495            default: false
   496          - name: override_file_name
   497            in: query
   498            required: false
   499            type: string
   500            default: ""
   501        responses:
   502          200:
   503            description: A successful response.
   504            schema:
   505              type: file
   506          default:
   507            description: Generic error response.
   508            schema:
   509              $ref: "#/definitions/ApiError"
   510        tags:
   511          - Object
   512  
   513    /buckets/{bucket_name}/objects/share:
   514      get:
   515        summary: Shares an Object on a url
   516        operationId: ShareObject
   517        parameters:
   518          - name: bucket_name
   519            in: path
   520            required: true
   521            type: string
   522          - name: prefix
   523            in: query
   524            required: true
   525            type: string
   526          - name: version_id
   527            in: query
   528            required: true
   529            type: string
   530          - name: expires
   531            in: query
   532            required: false
   533            type: string
   534        responses:
   535          200:
   536            description: A successful response.
   537            schema:
   538              type: string
   539          default:
   540            description: Generic error response.
   541            schema:
   542              $ref: "#/definitions/ApiError"
   543        tags:
   544          - Object
   545    /buckets/{bucket_name}/objects/legalhold:
   546      put:
   547        summary: Put Object's legalhold status
   548        operationId: PutObjectLegalHold
   549        parameters:
   550          - name: bucket_name
   551            in: path
   552            required: true
   553            type: string
   554          - name: prefix
   555            in: query
   556            required: true
   557            type: string
   558          - name: version_id
   559            in: query
   560            required: true
   561            type: string
   562          - name: body
   563            in: body
   564            required: true
   565            schema:
   566              $ref: "#/definitions/putObjectLegalHoldRequest"
   567        responses:
   568          200:
   569            description: A successful response.
   570          default:
   571            description: Generic error response.
   572            schema:
   573              $ref: "#/definitions/ApiError"
   574        tags:
   575          - Object
   576  
   577    /buckets/{bucket_name}/objects/retention:
   578      put:
   579        summary: Put Object's retention status
   580        operationId: PutObjectRetention
   581        parameters:
   582          - name: bucket_name
   583            in: path
   584            required: true
   585            type: string
   586          - name: prefix
   587            in: query
   588            required: true
   589            type: string
   590          - name: version_id
   591            in: query
   592            required: true
   593            type: string
   594          - name: body
   595            in: body
   596            required: true
   597            schema:
   598              $ref: "#/definitions/putObjectRetentionRequest"
   599        responses:
   600          200:
   601            description: A successful response.
   602          default:
   603            description: Generic error response.
   604            schema:
   605              $ref: "#/definitions/ApiError"
   606        tags:
   607          - Object
   608      delete:
   609        summary: Delete Object retention from an object
   610        operationId: DeleteObjectRetention
   611        parameters:
   612          - name: bucket_name
   613            in: path
   614            required: true
   615            type: string
   616          - name: prefix
   617            in: query
   618            required: true
   619            type: string
   620          - name: version_id
   621            in: query
   622            required: true
   623            type: string
   624        responses:
   625          200:
   626            description: A successful response.
   627          default:
   628            description: Generic error response.
   629            schema:
   630              $ref: "#/definitions/ApiError"
   631        tags:
   632          - Object
   633  
   634    /buckets/{bucket_name}/objects/tags:
   635      put:
   636        summary: Put Object's tags
   637        operationId: PutObjectTags
   638        parameters:
   639          - name: bucket_name
   640            in: path
   641            required: true
   642            type: string
   643          - name: prefix
   644            in: query
   645            required: true
   646            type: string
   647          - name: version_id
   648            in: query
   649            required: true
   650            type: string
   651          - name: body
   652            in: body
   653            required: true
   654            schema:
   655              $ref: "#/definitions/putObjectTagsRequest"
   656        responses:
   657          200:
   658            description: A successful response.
   659          default:
   660            description: Generic error response.
   661            schema:
   662              $ref: "#/definitions/ApiError"
   663        tags:
   664          - Object
   665  
   666    /buckets/{bucket_name}/objects/restore:
   667      put:
   668        summary: Restore Object to a selected version
   669        operationId: PutObjectRestore
   670        parameters:
   671          - name: bucket_name
   672            in: path
   673            required: true
   674            type: string
   675          - name: prefix
   676            in: query
   677            required: true
   678            type: string
   679          - name: version_id
   680            in: query
   681            required: true
   682            type: string
   683        responses:
   684          200:
   685            description: A successful response.
   686          default:
   687            description: Generic error response.
   688            schema:
   689              $ref: "#/definitions/ApiError"
   690        tags:
   691          - Object
   692  
   693    /buckets/{bucket_name}/objects/metadata:
   694      get:
   695        summary: Gets the metadata of an object
   696        operationId: GetObjectMetadata
   697        parameters:
   698          - name: bucket_name
   699            in: path
   700            required: true
   701            type: string
   702          - name: prefix
   703            in: query
   704            required: true
   705            type: string
   706        responses:
   707          200:
   708            description: A successful response.
   709            schema:
   710              $ref: "#/definitions/metadata"
   711          default:
   712            description: Generic error response.
   713            schema:
   714              $ref: "#/definitions/ApiError"
   715        tags:
   716          - Object
   717  
   718    /buckets/{bucket_name}/tags:
   719      put:
   720        summary: Put Bucket's tags
   721        operationId: PutBucketTags
   722        parameters:
   723          - name: bucket_name
   724            in: path
   725            required: true
   726            type: string
   727          - name: body
   728            in: body
   729            required: true
   730            schema:
   731              $ref: "#/definitions/putBucketTagsRequest"
   732        responses:
   733          200:
   734            description: A successful response.
   735          default:
   736            description: Generic error response.
   737            schema:
   738              $ref: "#/definitions/ApiError"
   739        tags:
   740          - Bucket
   741  
   742    /buckets/{name}/set-policy:
   743      put:
   744        summary: Bucket Set Policy
   745        operationId: BucketSetPolicy
   746        parameters:
   747          - name: name
   748            in: path
   749            required: true
   750            type: string
   751          - name: body
   752            in: body
   753            required: true
   754            schema:
   755              $ref: "#/definitions/setBucketPolicyRequest"
   756        responses:
   757          200:
   758            description: A successful response.
   759            schema:
   760              $ref: "#/definitions/bucket"
   761          default:
   762            description: Generic error response.
   763            schema:
   764              $ref: "#/definitions/ApiError"
   765        tags:
   766          - Bucket
   767  
   768    /buckets/{name}/quota:
   769      get:
   770        summary: Get Bucket Quota
   771        operationId: GetBucketQuota
   772        parameters:
   773          - name: name
   774            in: path
   775            required: true
   776            type: string
   777        responses:
   778          200:
   779            description: A successful response.
   780            schema:
   781              $ref: "#/definitions/bucketQuota"
   782          default:
   783            description: Generic error response.
   784            schema:
   785              $ref: "#/definitions/ApiError"
   786        tags:
   787          - Bucket
   788      put:
   789        summary: Bucket Quota
   790        operationId: SetBucketQuota
   791        parameters:
   792          - name: name
   793            in: path
   794            required: true
   795            type: string
   796          - name: body
   797            in: body
   798            required: true
   799            schema:
   800              $ref: "#/definitions/setBucketQuota"
   801        responses:
   802          200:
   803            description: A successful response.
   804            schema:
   805              $ref: "#/definitions/bucket"
   806          default:
   807            description: Generic error response.
   808            schema:
   809              $ref: "#/definitions/ApiError"
   810        tags:
   811          - Bucket
   812  
   813    /buckets/{bucket_name}/events:
   814      get:
   815        summary: List Bucket Events
   816        operationId: ListBucketEvents
   817        parameters:
   818          - name: bucket_name
   819            in: path
   820            required: true
   821            type: string
   822          - $ref: "#/parameters/offset"
   823          - $ref: "#/parameters/limit"
   824        responses:
   825          200:
   826            description: A successful response.
   827            schema:
   828              $ref: "#/definitions/listBucketEventsResponse"
   829          default:
   830            description: Generic error response.
   831            schema:
   832              $ref: "#/definitions/ApiError"
   833        tags:
   834          - Bucket
   835      post:
   836        summary: Create Bucket Event
   837        operationId: CreateBucketEvent
   838        parameters:
   839          - name: bucket_name
   840            in: path
   841            required: true
   842            type: string
   843          - name: body
   844            in: body
   845            required: true
   846            schema:
   847              $ref: "#/definitions/bucketEventRequest"
   848        responses:
   849          201:
   850            description: A successful response.
   851          default:
   852            description: Generic error response.
   853            schema:
   854              $ref: "#/definitions/ApiError"
   855        tags:
   856          - Bucket
   857  
   858    /buckets/{bucket_name}/events/{arn}:
   859      delete:
   860        summary: Delete Bucket Event
   861        operationId: DeleteBucketEvent
   862        parameters:
   863          - name: bucket_name
   864            in: path
   865            required: true
   866            type: string
   867          - name: arn
   868            in: path
   869            required: true
   870            type: string
   871          - name: body
   872            in: body
   873            required: true
   874            schema:
   875              $ref: "#/definitions/notificationDeleteRequest"
   876        responses:
   877          204:
   878            description: A successful response.
   879          default:
   880            description: Generic error response.
   881            schema:
   882              $ref: "#/definitions/ApiError"
   883        tags:
   884          - Bucket
   885  
   886    /buckets/{bucket_name}/replication:
   887      get:
   888        summary: Bucket Replication
   889        operationId: GetBucketReplication
   890        parameters:
   891          - name: bucket_name
   892            in: path
   893            required: true
   894            type: string
   895        responses:
   896          200:
   897            description: A successful response.
   898            schema:
   899              $ref: "#/definitions/bucketReplicationResponse"
   900          default:
   901            description: Generic error response.
   902            schema:
   903              $ref: "#/definitions/ApiError"
   904        tags:
   905          - Bucket
   906  
   907    /buckets/{bucket_name}/replication/{rule_id}:
   908      get:
   909        summary: Bucket Replication
   910        operationId: GetBucketReplicationRule
   911        parameters:
   912          - name: bucket_name
   913            in: path
   914            required: true
   915            type: string
   916          - name: rule_id
   917            in: path
   918            required: true
   919            type: string
   920        responses:
   921          200:
   922            description: A successful response.
   923            schema:
   924              $ref: "#/definitions/bucketReplicationRule"
   925          default:
   926            description: Generic error response.
   927            schema:
   928              $ref: "#/definitions/ApiError"
   929        tags:
   930          - Bucket
   931  
   932      put:
   933        summary: Update Replication rule
   934        operationId: UpdateMultiBucketReplication
   935        parameters:
   936          - name: bucket_name
   937            in: path
   938            required: true
   939            type: string
   940          - name: rule_id
   941            in: path
   942            required: true
   943            type: string
   944          - name: body
   945            in: body
   946            required: true
   947            schema:
   948              $ref: "#/definitions/multiBucketReplicationEdit"
   949        responses:
   950          201:
   951            description: A successful response.
   952          default:
   953            description: Generic error response.
   954            schema:
   955              $ref: "#/definitions/ApiError"
   956        tags:
   957          - Bucket
   958  
   959      delete:
   960        summary: Bucket Replication Rule Delete
   961        operationId: DeleteBucketReplicationRule
   962        parameters:
   963          - name: bucket_name
   964            in: path
   965            required: true
   966            type: string
   967          - name: rule_id
   968            in: path
   969            required: true
   970            type: string
   971  
   972        responses:
   973          204:
   974            description: A successful response.
   975          default:
   976            description: Generic error response.
   977            schema:
   978              $ref: "#/definitions/ApiError"
   979        tags:
   980          - Bucket
   981  
   982    /buckets/{bucket_name}/delete-all-replication-rules:
   983      delete:
   984        summary: Deletes all replication rules from a bucket
   985        operationId: DeleteAllReplicationRules
   986        parameters:
   987          - name: bucket_name
   988            in: path
   989            required: true
   990            type: string
   991        responses:
   992          204:
   993            description: A successful response.
   994          default:
   995            description: Generic error response.
   996            schema:
   997              $ref: "#/definitions/ApiError"
   998        tags:
   999          - Bucket
  1000  
  1001    /buckets/{bucket_name}/delete-selected-replication-rules:
  1002      delete:
  1003        summary: Deletes selected replication rules from a bucket
  1004        operationId: DeleteSelectedReplicationRules
  1005        parameters:
  1006          - name: bucket_name
  1007            in: path
  1008            required: true
  1009            type: string
  1010          - name: rules
  1011            in: body
  1012            required: true
  1013            schema:
  1014              $ref: "#/definitions/bucketReplicationRuleList"
  1015        responses:
  1016          204:
  1017            description: A successful response.
  1018          default:
  1019            description: Generic error response.
  1020            schema:
  1021              $ref: "#/definitions/ApiError"
  1022        tags:
  1023          - Bucket
  1024  
  1025    /buckets/{bucket_name}/versioning:
  1026      get:
  1027        summary: Bucket Versioning
  1028        operationId: GetBucketVersioning
  1029        parameters:
  1030          - name: bucket_name
  1031            in: path
  1032            required: true
  1033            type: string
  1034        responses:
  1035          200:
  1036            description: A successful response.
  1037            schema:
  1038              $ref: "#/definitions/bucketVersioningResponse"
  1039          default:
  1040            description: Generic error response.
  1041            schema:
  1042              $ref: "#/definitions/ApiError"
  1043        tags:
  1044          - Bucket
  1045      put:
  1046        summary: Set Bucket Versioning
  1047        operationId: SetBucketVersioning
  1048        parameters:
  1049          - name: bucket_name
  1050            in: path
  1051            required: true
  1052            type: string
  1053          - name: body
  1054            in: body
  1055            required: true
  1056            schema:
  1057              $ref: "#/definitions/setBucketVersioning"
  1058        responses:
  1059          201:
  1060            description: A successful response.
  1061          default:
  1062            description: Generic error response.
  1063            schema:
  1064              $ref: "#/definitions/ApiError"
  1065        tags:
  1066          - Bucket
  1067  
  1068    /buckets/{bucket_name}/object-locking:
  1069      get:
  1070        summary: Returns the status of object locking support on the bucket
  1071        operationId: GetBucketObjectLockingStatus
  1072        parameters:
  1073          - name: bucket_name
  1074            in: path
  1075            required: true
  1076            type: string
  1077        responses:
  1078          200:
  1079            description: A successful response.
  1080            schema:
  1081              $ref: "#/definitions/bucketObLockingResponse"
  1082          default:
  1083            description: Generic error response.
  1084            schema:
  1085              $ref: "#/definitions/ApiError"
  1086        tags:
  1087          - Bucket
  1088  
  1089    /buckets/{bucket_name}/encryption/enable:
  1090      post:
  1091        summary: Enable bucket encryption.
  1092        operationId: EnableBucketEncryption
  1093        parameters:
  1094          - name: bucket_name
  1095            in: path
  1096            required: true
  1097            type: string
  1098          - name: body
  1099            in: body
  1100            required: true
  1101            schema:
  1102              $ref: "#/definitions/bucketEncryptionRequest"
  1103        responses:
  1104          200:
  1105            description: A successful response.
  1106          default:
  1107            description: Generic error response.
  1108            schema:
  1109              $ref: "#/definitions/ApiError"
  1110        tags:
  1111          - Bucket
  1112  
  1113    /buckets/{bucket_name}/encryption/disable:
  1114      post:
  1115        summary: Disable bucket encryption.
  1116        operationId: DisableBucketEncryption
  1117        parameters:
  1118          - name: bucket_name
  1119            in: path
  1120            required: true
  1121            type: string
  1122        responses:
  1123          200:
  1124            description: A successful response.
  1125          default:
  1126            description: Generic error response.
  1127            schema:
  1128              $ref: "#/definitions/ApiError"
  1129        tags:
  1130          - Bucket
  1131  
  1132    /buckets/{bucket_name}/encryption/info:
  1133      get:
  1134        summary: Get bucket encryption information.
  1135        operationId: GetBucketEncryptionInfo
  1136        parameters:
  1137          - name: bucket_name
  1138            in: path
  1139            required: true
  1140            type: string
  1141        responses:
  1142          200:
  1143            description: A successful response.
  1144            schema:
  1145              $ref: "#/definitions/bucketEncryptionInfo"
  1146          default:
  1147            description: Generic error response.
  1148            schema:
  1149              $ref: "#/definitions/ApiError"
  1150        tags:
  1151          - Bucket
  1152  
  1153    /buckets/{bucket_name}/lifecycle:
  1154      get:
  1155        summary: Bucket Lifecycle
  1156        operationId: GetBucketLifecycle
  1157        parameters:
  1158          - name: bucket_name
  1159            in: path
  1160            required: true
  1161            type: string
  1162        responses:
  1163          200:
  1164            description: A successful response.
  1165            schema:
  1166              $ref: "#/definitions/bucketLifecycleResponse"
  1167          default:
  1168            description: Generic error response.
  1169            schema:
  1170              $ref: "#/definitions/ApiError"
  1171        tags:
  1172          - Bucket
  1173      post:
  1174        summary: Add Bucket Lifecycle
  1175        operationId: AddBucketLifecycle
  1176        parameters:
  1177          - name: bucket_name
  1178            in: path
  1179            required: true
  1180            type: string
  1181          - name: body
  1182            in: body
  1183            required: true
  1184            schema:
  1185              $ref: "#/definitions/addBucketLifecycle"
  1186        responses:
  1187          201:
  1188            description: A successful response.
  1189          default:
  1190            description: Generic error response.
  1191            schema:
  1192              $ref: "#/definitions/ApiError"
  1193        tags:
  1194          - Bucket
  1195  
  1196    /buckets/multi-lifecycle:
  1197      post:
  1198        summary: Add Multi Bucket Lifecycle
  1199        operationId: AddMultiBucketLifecycle
  1200        parameters:
  1201          - name: body
  1202            in: body
  1203            required: true
  1204            schema:
  1205              $ref: "#/definitions/addMultiBucketLifecycle"
  1206        responses:
  1207          200:
  1208            description: A successful response.
  1209            schema:
  1210              $ref: "#/definitions/multiLifecycleResult"
  1211          default:
  1212            description: Generic error response.
  1213            schema:
  1214              $ref: "#/definitions/ApiError"
  1215        tags:
  1216          - Bucket
  1217  
  1218    /buckets/{bucket_name}/lifecycle/{lifecycle_id}:
  1219      put:
  1220        summary: Update Lifecycle rule
  1221        operationId: UpdateBucketLifecycle
  1222        parameters:
  1223          - name: bucket_name
  1224            in: path
  1225            required: true
  1226            type: string
  1227          - name: lifecycle_id
  1228            in: path
  1229            required: true
  1230            type: string
  1231          - name: body
  1232            in: body
  1233            required: true
  1234            schema:
  1235              $ref: "#/definitions/updateBucketLifecycle"
  1236        responses:
  1237          200:
  1238            description: A successful response.
  1239          default:
  1240            description: Generic error response.
  1241            schema:
  1242              $ref: "#/definitions/ApiError"
  1243        tags:
  1244          - Bucket
  1245  
  1246      delete:
  1247        summary: Delete Lifecycle rule
  1248        operationId: DeleteBucketLifecycleRule
  1249        parameters:
  1250          - name: bucket_name
  1251            in: path
  1252            required: true
  1253            type: string
  1254          - name: lifecycle_id
  1255            in: path
  1256            required: true
  1257            type: string
  1258        responses:
  1259          204:
  1260            description: A successful response.
  1261          default:
  1262            description: Generic error response.
  1263            schema:
  1264              $ref: "#/definitions/ApiError"
  1265        tags:
  1266          - Bucket
  1267  
  1268    /buckets/{bucket_name}/rewind/{date}:
  1269      get:
  1270        summary: Get objects in a bucket for a rewind date
  1271        operationId: GetBucketRewind
  1272        parameters:
  1273          - name: bucket_name
  1274            in: path
  1275            required: true
  1276            type: string
  1277          - name: date
  1278            in: path
  1279            required: true
  1280            type: string
  1281          - name: prefix
  1282            in: query
  1283            required: false
  1284            type: string
  1285        responses:
  1286          200:
  1287            description: A successful response.
  1288            schema:
  1289              $ref: "#/definitions/rewindResponse"
  1290          default:
  1291            description: Generic error response.
  1292            schema:
  1293              $ref: "#/definitions/ApiError"
  1294        tags:
  1295          - Bucket
  1296  
  1297    /buckets/max-share-exp:
  1298      get:
  1299        summary: Get max expiration time for share link in seconds
  1300        operationId: GetMaxShareLinkExp
  1301        responses:
  1302          200:
  1303            description: A successful response.
  1304            schema:
  1305              $ref: "#/definitions/maxShareLinkExpResponse"
  1306          default:
  1307            description: Generic error response.
  1308            schema:
  1309              $ref: "#/definitions/ApiError"
  1310        tags:
  1311          - Bucket
  1312  
  1313    /list-external-buckets:
  1314      post:
  1315        summary: Lists an External list of buckets using custom credentials
  1316        operationId: ListExternalBuckets
  1317        parameters:
  1318          - name: body
  1319            in: body
  1320            required: true
  1321            schema:
  1322              $ref: "#/definitions/listExternalBucketsParams"
  1323        responses:
  1324          200:
  1325            description: A successful response.
  1326            schema:
  1327              $ref: "#/definitions/listBucketsResponse"
  1328          default:
  1329            description: Generic error response.
  1330            schema:
  1331              $ref: "#/definitions/ApiError"
  1332        tags:
  1333          - Bucket
  1334  
  1335    /buckets-replication:
  1336      post:
  1337        summary: Sets Multi Bucket Replication in multiple Buckets
  1338        operationId: SetMultiBucketReplication
  1339        parameters:
  1340          - name: body
  1341            in: body
  1342            required: true
  1343            schema:
  1344              $ref: "#/definitions/multiBucketReplication"
  1345        responses:
  1346          200:
  1347            description: A successful response.
  1348            schema:
  1349              $ref: "#/definitions/multiBucketResponseState"
  1350          default:
  1351            description: Generic error response.
  1352            schema:
  1353              $ref: "#/definitions/ApiError"
  1354        tags:
  1355          - Bucket
  1356  
  1357    /service-accounts:
  1358      get:
  1359        summary: List User's Service Accounts
  1360        operationId: ListUserServiceAccounts
  1361        parameters:
  1362          - $ref: "#/parameters/offset"
  1363          - $ref: "#/parameters/limit"
  1364        responses:
  1365          200:
  1366            description: A successful response.
  1367            schema:
  1368              $ref: "#/definitions/serviceAccounts"
  1369          default:
  1370            description: Generic error response.
  1371            schema:
  1372              $ref: "#/definitions/ApiError"
  1373        tags:
  1374          - ServiceAccount
  1375      post:
  1376        summary: Create Service Account
  1377        operationId: CreateServiceAccount
  1378        parameters:
  1379          - name: body
  1380            in: body
  1381            required: true
  1382            schema:
  1383              $ref: "#/definitions/serviceAccountRequest"
  1384        responses:
  1385          201:
  1386            description: A successful response.
  1387            schema:
  1388              $ref: "#/definitions/serviceAccountCreds"
  1389          default:
  1390            description: Generic error response.
  1391            schema:
  1392              $ref: "#/definitions/ApiError"
  1393        tags:
  1394          - ServiceAccount
  1395  
  1396    /service-account-credentials:
  1397      post:
  1398        summary: Create Service Account With Credentials
  1399        operationId: CreateServiceAccountCreds
  1400        parameters:
  1401          - name: body
  1402            in: body
  1403            required: true
  1404            schema:
  1405              $ref: "#/definitions/serviceAccountRequestCreds"
  1406        responses:
  1407          201:
  1408            description: A successful response.
  1409            schema:
  1410              $ref: "#/definitions/serviceAccountCreds"
  1411          default:
  1412            description: Generic error response.
  1413            schema:
  1414              $ref: "#/definitions/ApiError"
  1415        tags:
  1416          - ServiceAccount
  1417  
  1418    /service-accounts/delete-multi:
  1419      delete:
  1420        summary: Delete Multiple Service Accounts
  1421        operationId: DeleteMultipleServiceAccounts
  1422        parameters:
  1423          - name: selectedSA
  1424            in: body
  1425            required: true
  1426            schema:
  1427              $ref: "#/definitions/selectedSAs"
  1428        responses:
  1429          204:
  1430            description: A successful response.
  1431          default:
  1432            description: Generic error response.
  1433            schema:
  1434              $ref: "#/definitions/ApiError"
  1435        tags:
  1436          - ServiceAccount
  1437  
  1438    /service-accounts/{access_key}:
  1439      get:
  1440        summary: Get Service Account
  1441        operationId: GetServiceAccount
  1442        parameters:
  1443          - name: access_key
  1444            in: path
  1445            required: true
  1446            type: string
  1447        responses:
  1448          200:
  1449            description: A successful response.
  1450            schema:
  1451              $ref: "#/definitions/serviceAccount"
  1452          default:
  1453            description: Generic error response.
  1454            schema:
  1455              $ref: "#/definitions/ApiError"
  1456        tags:
  1457          - ServiceAccount
  1458      put:
  1459        summary: Set Service Account Policy
  1460        operationId: UpdateServiceAccount
  1461        parameters:
  1462          - name: access_key
  1463            in: path
  1464            required: true
  1465            type: string
  1466          - name: body
  1467            in: body
  1468            required: true
  1469            schema:
  1470              $ref: "#/definitions/updateServiceAccountRequest"
  1471        responses:
  1472          200:
  1473            description: A successful response.
  1474          default:
  1475            description: Generic error response.
  1476            schema:
  1477              $ref: "#/definitions/ApiError"
  1478        tags:
  1479          - ServiceAccount
  1480      delete:
  1481        summary: Delete Service Account
  1482        operationId: DeleteServiceAccount
  1483        parameters:
  1484          - name: access_key
  1485            in: path
  1486            required: true
  1487            type: string
  1488        responses:
  1489          204:
  1490            description: A successful response.
  1491          default:
  1492            description: Generic error response.
  1493            schema:
  1494              $ref: "#/definitions/ApiError"
  1495        tags:
  1496          - ServiceAccount
  1497  
  1498    /users:
  1499      get:
  1500        summary: List Users
  1501        operationId: ListUsers
  1502        parameters:
  1503          - $ref: "#/parameters/offset"
  1504          - $ref: "#/parameters/limit"
  1505        responses:
  1506          200:
  1507            description: A successful response.
  1508            schema:
  1509              $ref: "#/definitions/listUsersResponse"
  1510          default:
  1511            description: Generic error response.
  1512            schema:
  1513              $ref: "#/definitions/ApiError"
  1514        tags:
  1515          - User
  1516      post:
  1517        summary: Add User
  1518        operationId: AddUser
  1519        parameters:
  1520          - name: body
  1521            in: body
  1522            required: true
  1523            schema:
  1524              $ref: "#/definitions/addUserRequest"
  1525        responses:
  1526          201:
  1527            description: A successful response.
  1528            schema:
  1529              $ref: "#/definitions/user"
  1530          default:
  1531            description: Generic error response.
  1532            schema:
  1533              $ref: "#/definitions/ApiError"
  1534        tags:
  1535          - User
  1536  
  1537    /users/service-accounts:
  1538      post:
  1539        summary: Check number of service accounts for each user specified
  1540        operationId: CheckUserServiceAccounts
  1541        parameters:
  1542          - name: selectedUsers
  1543            in: body
  1544            required: true
  1545            schema:
  1546              $ref: "#/definitions/selectedUsers"
  1547        responses:
  1548          200:
  1549            description: A successful response.
  1550            schema:
  1551              $ref: "#/definitions/userServiceAccountSummary"
  1552          default:
  1553            description: Generic error response.
  1554            schema:
  1555              $ref: "#/definitions/ApiError"
  1556        tags:
  1557          - User
  1558  
  1559    /user/{name}:
  1560      get:
  1561        summary: Get User Info
  1562        operationId: GetUserInfo
  1563        parameters:
  1564          - name: name
  1565            in: path
  1566            required: true
  1567            type: string
  1568        responses:
  1569          200:
  1570            description: A successful response.
  1571            schema:
  1572              $ref: "#/definitions/user"
  1573          default:
  1574            description: Generic error response.
  1575            schema:
  1576              $ref: "#/definitions/ApiError"
  1577        tags:
  1578          - User
  1579      put:
  1580        summary: Update User Info
  1581        operationId: UpdateUserInfo
  1582        parameters:
  1583          - name: name
  1584            in: path
  1585            required: true
  1586            type: string
  1587          - name: body
  1588            in: body
  1589            required: true
  1590            schema:
  1591              $ref: "#/definitions/updateUser"
  1592        responses:
  1593          200:
  1594            description: A successful response.
  1595            schema:
  1596              $ref: "#/definitions/user"
  1597          default:
  1598            description: Generic error response.
  1599            schema:
  1600              $ref: "#/definitions/ApiError"
  1601        tags:
  1602          - User
  1603      delete:
  1604        summary: Remove user
  1605        operationId: RemoveUser
  1606        parameters:
  1607          - name: name
  1608            in: path
  1609            required: true
  1610            type: string
  1611        responses:
  1612          204:
  1613            description: A successful response.
  1614          default:
  1615            description: Generic error response.
  1616            schema:
  1617              $ref: "#/definitions/ApiError"
  1618        tags:
  1619          - User
  1620  
  1621    /user/{name}/groups:
  1622      put:
  1623        summary: Update Groups for a user
  1624        operationId: UpdateUserGroups
  1625        parameters:
  1626          - name: name
  1627            in: path
  1628            required: true
  1629            type: string
  1630          - name: body
  1631            in: body
  1632            required: true
  1633            schema:
  1634              $ref: "#/definitions/updateUserGroups"
  1635        responses:
  1636          200:
  1637            description: A successful response.
  1638            schema:
  1639              $ref: "#/definitions/user"
  1640          default:
  1641            description: Generic error response.
  1642            schema:
  1643              $ref: "#/definitions/ApiError"
  1644        tags:
  1645          - User
  1646    /user/policy:
  1647      get:
  1648        summary: returns policies for logged in user
  1649        operationId: GetUserPolicy
  1650        responses:
  1651          200:
  1652            description: A successful response.
  1653            schema:
  1654              type: string
  1655          default:
  1656            description: Generic error response.
  1657            schema:
  1658              $ref: "#/definitions/ApiError"
  1659        tags:
  1660          - Policy
  1661    /user/{name}/policies:
  1662      get:
  1663        summary: returns policies assigned for a specified user
  1664        operationId: GetSAUserPolicy
  1665        parameters:
  1666          - name: name
  1667            in: path
  1668            required: true
  1669            type: string
  1670        responses:
  1671          200:
  1672            description: A successful response.
  1673            schema:
  1674              $ref: "#/definitions/aUserPolicyResponse"
  1675          default:
  1676            description: Generic error response.
  1677            schema:
  1678              $ref: "#/definitions/ApiError"
  1679        tags:
  1680          - Policy
  1681    /user/{name}/service-accounts:
  1682      get:
  1683        summary: returns a list of service accounts for a user
  1684        operationId: ListAUserServiceAccounts
  1685        parameters:
  1686          - name: name
  1687            in: path
  1688            required: true
  1689            type: string
  1690        responses:
  1691          200:
  1692            description: A successful response.
  1693            schema:
  1694              $ref: "#/definitions/serviceAccounts"
  1695          default:
  1696            description: Generic error response.
  1697            schema:
  1698              $ref: "#/definitions/ApiError"
  1699        tags:
  1700          - User
  1701      post:
  1702        summary: Create Service Account for User
  1703        operationId: CreateAUserServiceAccount
  1704        parameters:
  1705          - name: name
  1706            in: path
  1707            required: true
  1708            type: string
  1709          - name: body
  1710            in: body
  1711            required: true
  1712            schema:
  1713              $ref: "#/definitions/serviceAccountRequest"
  1714        responses:
  1715          201:
  1716            description: A successful response.
  1717            schema:
  1718              $ref: "#/definitions/serviceAccountCreds"
  1719          default:
  1720            description: Generic error response.
  1721            schema:
  1722              $ref: "#/definitions/ApiError"
  1723        tags:
  1724          - User
  1725  
  1726    /user/{name}/service-account-credentials:
  1727      post:
  1728        summary: Create Service Account for User With Credentials
  1729        operationId: CreateServiceAccountCredentials
  1730        parameters:
  1731          - name: name
  1732            in: path
  1733            required: true
  1734            type: string
  1735          - name: body
  1736            in: body
  1737            required: true
  1738            schema:
  1739              $ref: "#/definitions/serviceAccountRequestCreds"
  1740        responses:
  1741          201:
  1742            description: A successful response.
  1743            schema:
  1744              $ref: "#/definitions/serviceAccountCreds"
  1745          default:
  1746            description: Generic error response.
  1747            schema:
  1748              $ref: "#/definitions/ApiError"
  1749        tags:
  1750          - User
  1751  
  1752    /users-groups-bulk:
  1753      put:
  1754        summary: Bulk functionality to Add Users to Groups
  1755        operationId: BulkUpdateUsersGroups
  1756        parameters:
  1757          - name: body
  1758            in: body
  1759            required: true
  1760            schema:
  1761              $ref: "#/definitions/bulkUserGroups"
  1762        responses:
  1763          200:
  1764            description: A successful response.
  1765          default:
  1766            description: Generic error response.
  1767            schema:
  1768              $ref: "#/definitions/ApiError"
  1769        tags:
  1770          - User
  1771  
  1772    /groups:
  1773      get:
  1774        summary: List Groups
  1775        operationId: ListGroups
  1776        parameters:
  1777          - $ref: "#/parameters/offset"
  1778          - $ref: "#/parameters/limit"
  1779        responses:
  1780          200:
  1781            description: A successful response.
  1782            schema:
  1783              $ref: "#/definitions/listGroupsResponse"
  1784          default:
  1785            description: Generic error response.
  1786            schema:
  1787              $ref: "#/definitions/ApiError"
  1788        tags:
  1789          - Group
  1790      post:
  1791        summary: Add Group
  1792        operationId: AddGroup
  1793        parameters:
  1794          - name: body
  1795            in: body
  1796            required: true
  1797            schema:
  1798              $ref: "#/definitions/addGroupRequest"
  1799        responses:
  1800          201:
  1801            description: A successful response.
  1802          default:
  1803            description: Generic error response.
  1804            schema:
  1805              $ref: "#/definitions/ApiError"
  1806        tags:
  1807          - Group
  1808  
  1809    /group/{name}:
  1810      get:
  1811        summary: Group info
  1812        operationId: GroupInfo
  1813        parameters:
  1814          - name: name
  1815            in: path
  1816            required: true
  1817            type: string
  1818        responses:
  1819          200:
  1820            description: A successful response.
  1821            schema:
  1822              $ref: "#/definitions/group"
  1823          default:
  1824            description: Generic error response.
  1825            schema:
  1826              $ref: "#/definitions/ApiError"
  1827        tags:
  1828          - Group
  1829      delete:
  1830        summary: Remove group
  1831        operationId: RemoveGroup
  1832        parameters:
  1833          - name: name
  1834            in: path
  1835            required: true
  1836            type: string
  1837        responses:
  1838          204:
  1839            description: A successful response.
  1840          default:
  1841            description: Generic error response.
  1842            schema:
  1843              $ref: "#/definitions/ApiError"
  1844        tags:
  1845          - Group
  1846      put:
  1847        summary: Update Group Members or Status
  1848        operationId: UpdateGroup
  1849        parameters:
  1850          - name: name
  1851            in: path
  1852            required: true
  1853            type: string
  1854          - name: body
  1855            in: body
  1856            required: true
  1857            schema:
  1858              $ref: "#/definitions/updateGroupRequest"
  1859        responses:
  1860          200:
  1861            description: A successful response.
  1862            schema:
  1863              $ref: "#/definitions/group"
  1864          default:
  1865            description: Generic error response.
  1866            schema:
  1867              $ref: "#/definitions/ApiError"
  1868        tags:
  1869          - Group
  1870  
  1871    /policies:
  1872      get:
  1873        summary: List Policies
  1874        operationId: ListPolicies
  1875        parameters:
  1876          - $ref: "#/parameters/offset"
  1877          - $ref: "#/parameters/limit"
  1878        responses:
  1879          200:
  1880            description: A successful response.
  1881            schema:
  1882              $ref: "#/definitions/listPoliciesResponse"
  1883          default:
  1884            description: Generic error response.
  1885            schema:
  1886              $ref: "#/definitions/ApiError"
  1887        tags:
  1888          - Policy
  1889      post:
  1890        summary: Add Policy
  1891        operationId: AddPolicy
  1892        parameters:
  1893          - name: body
  1894            in: body
  1895            required: true
  1896            schema:
  1897              $ref: "#/definitions/addPolicyRequest"
  1898        responses:
  1899          201:
  1900            description: A successful response.
  1901            schema:
  1902              $ref: "#/definitions/policy"
  1903          default:
  1904            description: Generic error response.
  1905            schema:
  1906              $ref: "#/definitions/ApiError"
  1907        tags:
  1908          - Policy
  1909  
  1910    /policies/{policy}/users:
  1911      get:
  1912        summary: List Users for a Policy
  1913        operationId: ListUsersForPolicy
  1914        parameters:
  1915          - name: policy
  1916            in: path
  1917            required: true
  1918            type: string
  1919        responses:
  1920          200:
  1921            description: A successful response.
  1922            schema:
  1923              type: array
  1924              items:
  1925                type: string
  1926          default:
  1927            description: Generic error response.
  1928            schema:
  1929              $ref: "#/definitions/ApiError"
  1930        tags:
  1931          - Policy
  1932  
  1933    /policies/{policy}/groups:
  1934      get:
  1935        summary: List Groups for a Policy
  1936        operationId: ListGroupsForPolicy
  1937        parameters:
  1938          - name: policy
  1939            in: path
  1940            required: true
  1941            type: string
  1942        responses:
  1943          200:
  1944            description: A successful response.
  1945            schema:
  1946              type: array
  1947              items:
  1948                type: string
  1949          default:
  1950            description: Generic error response.
  1951            schema:
  1952              $ref: "#/definitions/ApiError"
  1953        tags:
  1954          - Policy
  1955  
  1956    /bucket-policy/{bucket}:
  1957      get:
  1958        summary: List Policies With Given Bucket
  1959        operationId: ListPoliciesWithBucket
  1960        parameters:
  1961          - name: bucket
  1962            in: path
  1963            required: true
  1964            type: string
  1965          - $ref: "#/parameters/offset"
  1966          - $ref: "#/parameters/limit"
  1967        responses:
  1968          200:
  1969            description: A successful response.
  1970            schema:
  1971              $ref: "#/definitions/listPoliciesResponse"
  1972          default:
  1973            description: Generic error response.
  1974            schema:
  1975              $ref: "#/definitions/ApiError"
  1976        tags:
  1977          - Bucket
  1978  
  1979    /bucket/{bucket}/access-rules:
  1980      put:
  1981        summary: Add Access Rule To Given Bucket
  1982        operationId: SetAccessRuleWithBucket
  1983        parameters:
  1984          - name: bucket
  1985            in: path
  1986            required: true
  1987            type: string
  1988          - name: prefixaccess
  1989            in: body
  1990            required: true
  1991            schema:
  1992              $ref: "#/definitions/prefixAccessPair"
  1993        responses:
  1994          200:
  1995            description: A successful response.
  1996            schema:
  1997              type: boolean
  1998          default:
  1999            description: Generic error response.
  2000            schema:
  2001              $ref: "#/definitions/ApiError"
  2002        tags:
  2003          - Bucket
  2004      get:
  2005        summary: List Access Rules With Given Bucket
  2006        operationId: ListAccessRulesWithBucket
  2007        parameters:
  2008          - name: bucket
  2009            in: path
  2010            required: true
  2011            type: string
  2012          - $ref: "#/parameters/offset"
  2013          - $ref: "#/parameters/limit"
  2014        responses:
  2015          200:
  2016            description: A successful response.
  2017            schema:
  2018              $ref: "#/definitions/listAccessRulesResponse"
  2019          default:
  2020            description: Generic error response.
  2021            schema:
  2022              $ref: "#/definitions/ApiError"
  2023        tags:
  2024          - Bucket
  2025      delete:
  2026        summary: Delete Access Rule From Given Bucket
  2027        operationId: DeleteAccessRuleWithBucket
  2028        parameters:
  2029          - name: bucket
  2030            in: path
  2031            required: true
  2032            type: string
  2033          - name: prefix
  2034            in: body
  2035            required: true
  2036            schema:
  2037              $ref: "#/definitions/prefixWrapper"
  2038        responses:
  2039          200:
  2040            description: A successful response.
  2041            schema:
  2042              type: boolean
  2043          default:
  2044            description: Generic error response.
  2045            schema:
  2046              $ref: "#/definitions/ApiError"
  2047        tags:
  2048          - Bucket
  2049  
  2050    /bucket-users/{bucket}:
  2051      get:
  2052        summary: List Users With Access to a Given Bucket
  2053        operationId: ListUsersWithAccessToBucket
  2054        parameters:
  2055          - name: bucket
  2056            in: path
  2057            required: true
  2058            type: string
  2059          - $ref: "#/parameters/offset"
  2060          - $ref: "#/parameters/limit"
  2061        responses:
  2062          200:
  2063            description: A successful response.
  2064            schema:
  2065              type: array
  2066              items:
  2067                type: string
  2068          default:
  2069            description: Generic error response.
  2070            schema:
  2071              $ref: "#/definitions/ApiError"
  2072        tags:
  2073          - Bucket
  2074  
  2075    /policy/{name}:
  2076      get:
  2077        summary: Policy info
  2078        operationId: PolicyInfo
  2079        parameters:
  2080          - name: name
  2081            in: path
  2082            required: true
  2083            type: string
  2084        responses:
  2085          200:
  2086            description: A successful response.
  2087            schema:
  2088              $ref: "#/definitions/policy"
  2089          default:
  2090            description: Generic error response.
  2091            schema:
  2092              $ref: "#/definitions/ApiError"
  2093        tags:
  2094          - Policy
  2095      delete:
  2096        summary: Remove policy
  2097        operationId: RemovePolicy
  2098        parameters:
  2099          - name: name
  2100            in: path
  2101            required: true
  2102            type: string
  2103        responses:
  2104          204:
  2105            description: A successful response.
  2106          default:
  2107            description: Generic error response.
  2108            schema:
  2109              $ref: "#/definitions/ApiError"
  2110        tags:
  2111          - Policy
  2112  
  2113    /configs:
  2114      get:
  2115        summary: List Configurations
  2116        operationId: ListConfig
  2117        parameters:
  2118          - $ref: "#/parameters/offset"
  2119          - $ref: "#/parameters/limit"
  2120        responses:
  2121          200:
  2122            description: A successful response.
  2123            schema:
  2124              $ref: "#/definitions/listConfigResponse"
  2125          default:
  2126            description: Generic error response.
  2127            schema:
  2128              $ref: "#/definitions/ApiError"
  2129        tags:
  2130          - Configuration
  2131  
  2132    /set-policy:
  2133      put:
  2134        summary: Set policy
  2135        operationId: SetPolicy
  2136        parameters:
  2137          - name: body
  2138            in: body
  2139            required: true
  2140            schema:
  2141              $ref: "#/definitions/setPolicyNameRequest"
  2142        responses:
  2143          204:
  2144            description: A successful response.
  2145          default:
  2146            description: Generic error response.
  2147            schema:
  2148              $ref: "#/definitions/ApiError"
  2149        tags:
  2150          - Policy
  2151  
  2152    /set-policy-multi:
  2153      put:
  2154        summary: Set policy to multiple users/groups
  2155        operationId: SetPolicyMultiple
  2156        parameters:
  2157          - name: body
  2158            in: body
  2159            required: true
  2160            schema:
  2161              $ref: "#/definitions/setPolicyMultipleNameRequest"
  2162        responses:
  2163          204:
  2164            description: A successful response.
  2165          default:
  2166            description: Generic error response.
  2167            schema:
  2168              $ref: "#/definitions/ApiError"
  2169        tags:
  2170          - Policy
  2171  
  2172    /configs/{name}:
  2173      get:
  2174        summary: Configuration info
  2175        operationId: ConfigInfo
  2176        parameters:
  2177          - name: name
  2178            in: path
  2179            required: true
  2180            type: string
  2181        responses:
  2182          200:
  2183            description: A successful response.
  2184            schema:
  2185              type: array
  2186              items:
  2187                $ref: "#/definitions/configuration"
  2188          default:
  2189            description: Generic error response.
  2190            schema:
  2191              $ref: "#/definitions/ApiError"
  2192        tags:
  2193          - Configuration
  2194      put:
  2195        summary: Set Configuration
  2196        operationId: SetConfig
  2197        parameters:
  2198          - name: name
  2199            in: path
  2200            required: true
  2201            type: string
  2202          - name: body
  2203            in: body
  2204            required: true
  2205            schema:
  2206              $ref: "#/definitions/setConfigRequest"
  2207        responses:
  2208          200:
  2209            description: A successful response.
  2210            schema:
  2211              $ref: "#/definitions/setConfigResponse"
  2212          default:
  2213            description: Generic error response.
  2214            schema:
  2215              $ref: "#/definitions/ApiError"
  2216        tags:
  2217          - Configuration
  2218  
  2219    /configs/{name}/reset:
  2220      post:
  2221        summary: Configuration reset
  2222        operationId: ResetConfig
  2223        parameters:
  2224          - name: name
  2225            in: path
  2226            required: true
  2227            type: string
  2228        responses:
  2229          200:
  2230            description: A successful response.
  2231            schema:
  2232              $ref: "#/definitions/setConfigResponse"
  2233          default:
  2234            description: Generic error response.
  2235            schema:
  2236              $ref: "#/definitions/ApiError"
  2237        tags:
  2238          - Configuration
  2239  
  2240    /configs/export:
  2241      get:
  2242        summary: Export the current config from MinIO server
  2243        operationId: ExportConfig
  2244        responses:
  2245          200:
  2246            description: A successful response.
  2247            schema:
  2248              $ref: "#/definitions/configExportResponse"
  2249          default:
  2250            description: Generic error response.
  2251            schema:
  2252              $ref: "#/definitions/ApiError"
  2253        tags:
  2254          - Configuration
  2255    /configs/import:
  2256      post:
  2257        summary: Uploads a file to import MinIO server config.
  2258        consumes:
  2259          - multipart/form-data
  2260        parameters:
  2261          - name: file
  2262            in: formData
  2263            required: true
  2264            type: file
  2265        responses:
  2266          200:
  2267            description: A successful response.
  2268          default:
  2269            description: Generic error response.
  2270            schema:
  2271              $ref: "#/definitions/ApiError"
  2272        tags:
  2273          - Configuration
  2274    /service/restart:
  2275      post:
  2276        summary: Restart Service
  2277        operationId: RestartService
  2278        responses:
  2279          204:
  2280            description: A successful response.
  2281          default:
  2282            description: Generic error response.
  2283            schema:
  2284              $ref: "#/definitions/ApiError"
  2285        tags:
  2286          - Service
  2287    /profiling/start:
  2288      post:
  2289        summary: Start recording profile data
  2290        operationId: ProfilingStart
  2291        parameters:
  2292          - name: body
  2293            in: body
  2294            required: true
  2295            schema:
  2296              $ref: "#/definitions/profilingStartRequest"
  2297        responses:
  2298          201:
  2299            description: A successful response.
  2300            schema:
  2301              $ref: "#/definitions/startProfilingList"
  2302          default:
  2303            description: Generic error response.
  2304            schema:
  2305              $ref: "#/definitions/ApiError"
  2306        tags:
  2307          - Profile
  2308  
  2309    /profiling/stop:
  2310      post:
  2311        summary: Stop and download profile data
  2312        operationId: ProfilingStop
  2313        produces:
  2314          - application/zip
  2315        responses:
  2316          201:
  2317            description: A successful response.
  2318            schema:
  2319              type: file
  2320          default:
  2321            description: Generic error response.
  2322            schema:
  2323              $ref: "#/definitions/ApiError"
  2324        tags:
  2325          - Profile
  2326    /subnet/registration-token:
  2327      get:
  2328        summary: SUBNET registraton token
  2329        operationId: SubnetRegToken
  2330        responses:
  2331          200:
  2332            description: A successful response.
  2333            schema:
  2334              $ref: "#/definitions/SubnetRegTokenResponse"
  2335          default:
  2336            description: Generic error response.
  2337            schema:
  2338              $ref: "#/definitions/ApiError"
  2339        tags:
  2340          - Subnet
  2341    /subnet/info:
  2342      get:
  2343        summary: Subnet info
  2344        operationId: SubnetInfo
  2345        responses:
  2346          200:
  2347            description: A successful response.
  2348            schema:
  2349              $ref: "#/definitions/license"
  2350          default:
  2351            description: Generic error response.
  2352            schema:
  2353              $ref: "#/definitions/ApiError"
  2354        tags:
  2355          - Subnet
  2356    /subnet/apikey:
  2357      get:
  2358        summary: Subnet api key
  2359        operationId: SubnetApiKey
  2360        parameters:
  2361          - name: token
  2362            in: query
  2363            required: true
  2364            type: string
  2365        responses:
  2366          200:
  2367            description: A successful response.
  2368            schema:
  2369              $ref: "#/definitions/apiKey"
  2370          default:
  2371            description: Generic error response.
  2372            schema:
  2373              $ref: "#/definitions/ApiError"
  2374        tags:
  2375          - Subnet
  2376    /subnet/register:
  2377      post:
  2378        summary: Register cluster with Subnet
  2379        operationId: SubnetRegister
  2380        parameters:
  2381          - name: body
  2382            in: body
  2383            required: true
  2384            schema:
  2385              $ref: "#/definitions/subnetRegisterRequest"
  2386        responses:
  2387          200:
  2388            description: A successful response.
  2389          #          schema:
  2390          #            $ref: "#/definitions/subnetRegisterResponse"
  2391          default:
  2392            description: Generic error response.
  2393            schema:
  2394              $ref: "#/definitions/ApiError"
  2395        tags:
  2396          - Subnet
  2397  
  2398    /subnet/login:
  2399      post:
  2400        summary: Login to SUBNET
  2401        operationId: SubnetLogin
  2402        parameters:
  2403          - name: body
  2404            in: body
  2405            required: true
  2406            schema:
  2407              $ref: "#/definitions/subnetLoginRequest"
  2408        responses:
  2409          200:
  2410            description: A successful response.
  2411            schema:
  2412              $ref: "#/definitions/subnetLoginResponse"
  2413          default:
  2414            description: Generic error response.
  2415            schema:
  2416              $ref: "#/definitions/ApiError"
  2417        tags:
  2418          - Subnet
  2419  
  2420    /subnet/login/mfa:
  2421      post:
  2422        summary: Login to SUBNET using mfa
  2423        operationId: SubnetLoginMFA
  2424        parameters:
  2425          - name: body
  2426            in: body
  2427            required: true
  2428            schema:
  2429              $ref: "#/definitions/subnetLoginMFARequest"
  2430        responses:
  2431          200:
  2432            description: A successful response.
  2433            schema:
  2434              $ref: "#/definitions/subnetLoginResponse"
  2435          default:
  2436            description: Generic error response.
  2437            schema:
  2438              $ref: "#/definitions/ApiError"
  2439        tags:
  2440          - Subnet
  2441  
  2442    /admin/info:
  2443      get:
  2444        summary: Returns information about the deployment
  2445        operationId: AdminInfo
  2446        parameters:
  2447          - name: defaultOnly
  2448            in: query
  2449            required: false
  2450            type: boolean
  2451            default: false
  2452        responses:
  2453          200:
  2454            description: A successful response.
  2455            schema:
  2456              $ref: "#/definitions/adminInfoResponse"
  2457          default:
  2458            description: Generic error response.
  2459            schema:
  2460              $ref: "#/definitions/ApiError"
  2461        tags:
  2462          - System
  2463  
  2464    /admin/info/widgets/{widgetId}:
  2465      get:
  2466        summary: Returns information about the deployment
  2467        operationId: DashboardWidgetDetails
  2468        parameters:
  2469          - name: widgetId
  2470            in: path
  2471            type: integer
  2472            format: int32
  2473            required: true
  2474          - name: start
  2475            in: query
  2476            type: integer
  2477          - name: end
  2478            in: query
  2479            type: integer
  2480          - name: step
  2481            in: query
  2482            type: integer
  2483            format: int32
  2484        responses:
  2485          200:
  2486            description: A successful response.
  2487            schema:
  2488              $ref: "#/definitions/widgetDetails"
  2489          default:
  2490            description: Generic error response.
  2491            schema:
  2492              $ref: "#/definitions/ApiError"
  2493        tags:
  2494          - System
  2495  
  2496    /admin/arns:
  2497      get:
  2498        summary: Returns a list of active ARNs in the instance
  2499        operationId: ArnList
  2500        responses:
  2501          200:
  2502            description: A successful response.
  2503            schema:
  2504              $ref: "#/definitions/arnsResponse"
  2505          default:
  2506            description: Generic error response.
  2507            schema:
  2508              $ref: "#/definitions/ApiError"
  2509        tags:
  2510          - System
  2511  
  2512    /admin/notification_endpoints:
  2513      get:
  2514        summary: Returns a list of active notification endpoints
  2515        operationId: NotificationEndpointList
  2516        responses:
  2517          200:
  2518            description: A successful response.
  2519            schema:
  2520              $ref: "#/definitions/notifEndpointResponse"
  2521          default:
  2522            description: Generic error response.
  2523            schema:
  2524              $ref: "#/definitions/ApiError"
  2525        tags:
  2526          - Configuration
  2527      post:
  2528        summary: Allows to configure a new notification endpoint
  2529        operationId: AddNotificationEndpoint
  2530        parameters:
  2531          - name: body
  2532            in: body
  2533            required: true
  2534            schema:
  2535              $ref: "#/definitions/notificationEndpoint"
  2536        responses:
  2537          201:
  2538            description: A successful response.
  2539            schema:
  2540              $ref: "#/definitions/setNotificationEndpointResponse"
  2541          default:
  2542            description: Generic error response.
  2543            schema:
  2544              $ref: "#/definitions/ApiError"
  2545        tags:
  2546          - Configuration
  2547  
  2548    /admin/site-replication:
  2549      get:
  2550        summary: Get list of Replication Sites
  2551        operationId: GetSiteReplicationInfo
  2552        responses:
  2553          200:
  2554            description: A successful response.
  2555            schema:
  2556              $ref: "#/definitions/siteReplicationInfoResponse"
  2557          default:
  2558            description: Generic error response.
  2559            schema:
  2560              $ref: "#/definitions/ApiError"
  2561        tags:
  2562          - SiteReplication
  2563      post:
  2564        summary: Add a Replication Site
  2565        operationId: SiteReplicationInfoAdd
  2566        parameters:
  2567          - name: body
  2568            in: body
  2569            required: true
  2570            schema:
  2571              $ref: "#/definitions/siteReplicationAddRequest"
  2572        responses:
  2573          200:
  2574            description: A successful response.
  2575            schema:
  2576              $ref: "#/definitions/siteReplicationAddResponse"
  2577          default:
  2578            description: Generic error response.
  2579            schema:
  2580              $ref: "#/definitions/ApiError"
  2581        tags:
  2582          - SiteReplication
  2583      put:
  2584        summary: Edit a Replication Site
  2585        operationId: SiteReplicationEdit
  2586        parameters:
  2587          - name: body
  2588            in: body
  2589            required: true
  2590            schema:
  2591              $ref: "#/definitions/peerInfo"
  2592        responses:
  2593          200:
  2594            description: A successful response.
  2595            schema:
  2596              $ref: "#/definitions/peerSiteEditResponse"
  2597          default:
  2598            description: Generic error response.
  2599            schema:
  2600              $ref: "#/definitions/ApiError"
  2601        tags:
  2602          - SiteReplication
  2603      delete:
  2604        summary: Remove a Replication Site
  2605        operationId: SiteReplicationRemove
  2606        parameters:
  2607          - name: body
  2608            in: body
  2609            required: true
  2610            schema:
  2611              $ref: "#/definitions/peerInfoRemove"
  2612        responses:
  2613          204:
  2614            description: A successful response.
  2615            schema:
  2616              $ref: "#/definitions/peerSiteRemoveResponse"
  2617          default:
  2618            description: Generic error response.
  2619            schema:
  2620              $ref: "#/definitions/ApiError"
  2621        tags:
  2622          - SiteReplication
  2623  
  2624    /admin/site-replication/status:
  2625      get:
  2626        summary: Display overall site replication status
  2627        operationId: GetSiteReplicationStatus
  2628        parameters:
  2629          - name: buckets
  2630            description: Include Bucket stats
  2631            in: query
  2632            type: boolean
  2633            default: true
  2634          - name: groups
  2635            description: Include Group stats
  2636            in: query
  2637            type: boolean
  2638            default: true
  2639          - name: policies
  2640            description: Include Policies stats
  2641            in: query
  2642            type: boolean
  2643            default: true
  2644          - name: users
  2645            description: Include Policies stats
  2646            in: query
  2647            type: boolean
  2648            default: true
  2649          - name: entityType
  2650            description: Entity Type to lookup
  2651            in: query
  2652            type: string
  2653            required: false
  2654          - name: entityValue
  2655            description: Entity Value to lookup
  2656            in: query
  2657            type: string
  2658            required: false
  2659        responses:
  2660          200:
  2661            description: A successful response.
  2662            schema:
  2663              $ref: "#/definitions/siteReplicationStatusResponse"
  2664          default:
  2665            description: Generic error response.
  2666            schema:
  2667              $ref: "#/definitions/ApiError"
  2668        tags:
  2669          - SiteReplication
  2670  
  2671    /admin/tiers:
  2672      get:
  2673        summary: Returns a list of tiers for ilm
  2674        operationId: TiersList
  2675        responses:
  2676          200:
  2677            description: A successful response.
  2678            schema:
  2679              $ref: "#/definitions/tierListResponse"
  2680          default:
  2681            description: Generic error response.
  2682            schema:
  2683              $ref: "#/definitions/ApiError"
  2684        tags:
  2685          - Tiering
  2686      post:
  2687        summary: Allows to configure a new tier
  2688        operationId: AddTier
  2689        parameters:
  2690          - name: body
  2691            in: body
  2692            required: true
  2693            schema:
  2694              $ref: "#/definitions/tier"
  2695        responses:
  2696          201:
  2697            description: A successful response.
  2698          default:
  2699            description: Generic error response.
  2700            schema:
  2701              $ref: "#/definitions/ApiError"
  2702        tags:
  2703          - Tiering
  2704  
  2705    /admin/tiers/{type}/{name}:
  2706      get:
  2707        summary: Get Tier
  2708        operationId: GetTier
  2709        parameters:
  2710          - name: type
  2711            in: path
  2712            required: true
  2713            type: string
  2714            enum:
  2715              - s3
  2716              - gcs
  2717              - azure
  2718              - minio
  2719          - name: name
  2720            in: path
  2721            required: true
  2722            type: string
  2723        responses:
  2724          200:
  2725            description: A successful response.
  2726            schema:
  2727              $ref: "#/definitions/tier"
  2728          default:
  2729            description: Generic error response.
  2730            schema:
  2731              $ref: "#/definitions/ApiError"
  2732        tags:
  2733          - Tiering
  2734  
  2735    /admin/tiers/{type}/{name}/credentials:
  2736      put:
  2737        summary: Edit Tier Credentials
  2738        operationId: EditTierCredentials
  2739        parameters:
  2740          - name: type
  2741            in: path
  2742            required: true
  2743            type: string
  2744            enum:
  2745              - s3
  2746              - gcs
  2747              - azure
  2748              - minio
  2749          - name: name
  2750            in: path
  2751            required: true
  2752            type: string
  2753          - name: body
  2754            in: body
  2755            required: true
  2756            schema:
  2757              $ref: "#/definitions/tierCredentialsRequest"
  2758        responses:
  2759          200:
  2760            description: A successful response.
  2761          default:
  2762            description: Generic error response.
  2763            schema:
  2764              $ref: "#/definitions/ApiError"
  2765        tags:
  2766          - Tiering
  2767  
  2768    /nodes:
  2769      get:
  2770        summary: Lists Nodes
  2771        operationId: ListNodes
  2772        responses:
  2773          200:
  2774            description: A successful response.
  2775            schema:
  2776              type: array
  2777              items:
  2778                type: string
  2779          default:
  2780            description: Generic error response.
  2781            schema:
  2782              $ref: "#/definitions/ApiError"
  2783        tags:
  2784          - System
  2785  
  2786    /remote-buckets:
  2787      get:
  2788        summary: List Remote Buckets
  2789        operationId: ListRemoteBuckets
  2790        responses:
  2791          200:
  2792            description: A successful response.
  2793            schema:
  2794              $ref: "#/definitions/listRemoteBucketsResponse"
  2795          default:
  2796            description: Generic error response.
  2797            schema:
  2798              $ref: "#/definitions/ApiError"
  2799        tags:
  2800          - Bucket
  2801      post:
  2802        summary: Add Remote Bucket
  2803        operationId: AddRemoteBucket
  2804        parameters:
  2805          - name: body
  2806            in: body
  2807            required: true
  2808            schema:
  2809              $ref: "#/definitions/createRemoteBucket"
  2810        responses:
  2811          201:
  2812            description: A successful response.
  2813          default:
  2814            description: Generic error response.
  2815            schema:
  2816              $ref: "#/definitions/ApiError"
  2817        tags:
  2818          - Bucket
  2819  
  2820    /remote-buckets/{name}:
  2821      get:
  2822        summary: Remote Bucket Details
  2823        operationId: RemoteBucketDetails
  2824        parameters:
  2825          - name: name
  2826            in: path
  2827            required: true
  2828            type: string
  2829        responses:
  2830          200:
  2831            description: A successful response.
  2832            schema:
  2833              $ref: "#/definitions/remoteBucket"
  2834          default:
  2835            description: Generic error response.
  2836            schema:
  2837              $ref: "#/definitions/ApiError"
  2838        tags:
  2839          - Bucket
  2840    /remote-buckets/{source-bucket-name}/{arn}:
  2841      delete:
  2842        summary: Delete Remote Bucket
  2843        operationId: DeleteRemoteBucket
  2844        parameters:
  2845          - name: source-bucket-name
  2846            in: path
  2847            required: true
  2848            type: string
  2849          - name: arn
  2850            in: path
  2851            required: true
  2852            type: string
  2853        responses:
  2854          204:
  2855            description: A successful response.
  2856          default:
  2857            description: Generic error response.
  2858            schema:
  2859              $ref: "#/definitions/ApiError"
  2860        tags:
  2861          - Bucket
  2862    /logs/search:
  2863      get:
  2864        summary: Search the logs
  2865        operationId: LogSearch
  2866        parameters:
  2867          - name: fp
  2868            description: Filter Parameters
  2869            in: query
  2870            collectionFormat: multi
  2871            type: array
  2872            items:
  2873              type: string
  2874          - name: pageSize
  2875            in: query
  2876            type: number
  2877            format: int32
  2878            default: 10
  2879          - name: pageNo
  2880            in: query
  2881            type: number
  2882            format: int32
  2883            default: 0
  2884          - name: order
  2885            in: query
  2886            type: string
  2887            enum: [timeDesc, timeAsc]
  2888            default: timeDesc
  2889          - name: timeStart
  2890            in: query
  2891            type: string
  2892          - name: timeEnd
  2893            in: query
  2894            type: string
  2895        responses:
  2896          200:
  2897            description: A successful response.
  2898            schema:
  2899              $ref: "#/definitions/logSearchResponse"
  2900          default:
  2901            description: Generic error response.
  2902            schema:
  2903              $ref: "#/definitions/ApiError"
  2904        tags:
  2905          - Logging
  2906  
  2907    /kms/status:
  2908      get:
  2909        summary: KMS status
  2910        operationId: KMSStatus
  2911        responses:
  2912          200:
  2913            description: A successful response.
  2914            schema:
  2915              $ref: "#/definitions/kmsStatusResponse"
  2916          default:
  2917            description: Generic error response.
  2918            schema:
  2919              $ref: "#/definitions/ApiError"
  2920        tags:
  2921          - KMS
  2922    /kms/metrics:
  2923      get:
  2924        summary: KMS metrics
  2925        operationId: KMSMetrics
  2926        responses:
  2927          200:
  2928            description: A successful response.
  2929            schema:
  2930              $ref: "#/definitions/kmsMetricsResponse"
  2931          default:
  2932            description: Generic error response.
  2933            schema:
  2934              $ref: "#/definitions/ApiError"
  2935        tags:
  2936          - KMS
  2937    /kms/apis:
  2938      get:
  2939        summary: KMS apis
  2940        operationId: KMSAPIs
  2941        responses:
  2942          200:
  2943            description: A successful response.
  2944            schema:
  2945              $ref: "#/definitions/kmsAPIsResponse"
  2946          default:
  2947            description: Generic error response.
  2948            schema:
  2949              $ref: "#/definitions/ApiError"
  2950        tags:
  2951          - KMS
  2952    /kms/version:
  2953      get:
  2954        summary: KMS version
  2955        operationId: KMSVersion
  2956        responses:
  2957          200:
  2958            description: A successful response.
  2959            schema:
  2960              $ref: "#/definitions/kmsVersionResponse"
  2961          default:
  2962            description: Generic error response.
  2963            schema:
  2964              $ref: "#/definitions/ApiError"
  2965        tags:
  2966          - KMS
  2967    /kms/keys:
  2968      post:
  2969        summary: KMS create key
  2970        operationId: KMSCreateKey
  2971        parameters:
  2972          - name: body
  2973            in: body
  2974            required: true
  2975            schema:
  2976              $ref: "#/definitions/kmsCreateKeyRequest"
  2977        responses:
  2978          201:
  2979            description: A successful response.
  2980          default:
  2981            description: Generic error response.
  2982            schema:
  2983              $ref: "#/definitions/ApiError"
  2984        tags:
  2985          - KMS
  2986      get:
  2987        summary: KMS list keys
  2988        operationId: KMSListKeys
  2989        parameters:
  2990          - name: pattern
  2991            description: pattern to retrieve keys
  2992            in: query
  2993            type: string
  2994        responses:
  2995          200:
  2996            description: A successful response.
  2997            schema:
  2998              $ref: "#/definitions/kmsListKeysResponse"
  2999          default:
  3000            description: Generic error response.
  3001            schema:
  3002              $ref: "#/definitions/ApiError"
  3003        tags:
  3004          - KMS
  3005    /kms/keys/{name}:
  3006      get:
  3007        summary: KMS key status
  3008        operationId: KMSKeyStatus
  3009        parameters:
  3010          - name: name
  3011            description: KMS key name
  3012            in: path
  3013            required: true
  3014            type: string
  3015        responses:
  3016          200:
  3017            description: A successful response.
  3018            schema:
  3019              $ref: "#/definitions/kmsKeyStatusResponse"
  3020          default:
  3021            description: Generic error response.
  3022            schema:
  3023              $ref: "#/definitions/ApiError"
  3024        tags:
  3025          - KMS
  3026      delete:
  3027        summary: KMS delete key
  3028        operationId: KMSDeleteKey
  3029        parameters:
  3030          - name: name
  3031            description: KMS key name
  3032            in: path
  3033            required: true
  3034            type: string
  3035        responses:
  3036          200:
  3037            description: A successful response.
  3038          default:
  3039            description: Generic error response.
  3040            schema:
  3041              $ref: "#/definitions/ApiError"
  3042        tags:
  3043          - KMS
  3044    /kms/keys/{name}/import:
  3045      post:
  3046        summary: KMS import key
  3047        operationId: KMSImportKey
  3048        parameters:
  3049          - name: body
  3050            in: body
  3051            required: true
  3052            schema:
  3053              $ref: "#/definitions/kmsImportKeyRequest"
  3054          - name: name
  3055            description: KMS key name
  3056            in: path
  3057            required: true
  3058            type: string
  3059        responses:
  3060          201:
  3061            description: A successful response.
  3062          default:
  3063            description: Generic error response.
  3064            schema:
  3065              $ref: "#/definitions/ApiError"
  3066        tags:
  3067          - KMS
  3068    /kms/policies:
  3069      post:
  3070        summary: KMS set policy
  3071        operationId: KMSSetPolicy
  3072        parameters:
  3073          - name: body
  3074            in: body
  3075            required: true
  3076            schema:
  3077              $ref: "#/definitions/kmsSetPolicyRequest"
  3078        responses:
  3079          200:
  3080            description: A successful response.
  3081          default:
  3082            description: Generic error response.
  3083            schema:
  3084              $ref: "#/definitions/ApiError"
  3085        tags:
  3086          - KMS
  3087      get:
  3088        summary: KMS list policies
  3089        operationId: KMSListPolicies
  3090        parameters:
  3091          - name: pattern
  3092            description: pattern to retrieve policies
  3093            in: query
  3094            type: string
  3095        responses:
  3096          200:
  3097            description: A successful response.
  3098            schema:
  3099              $ref: "#/definitions/kmsListPoliciesResponse"
  3100          default:
  3101            description: Generic error response.
  3102            schema:
  3103              $ref: "#/definitions/ApiError"
  3104        tags:
  3105          - KMS
  3106    /kms/policies/{name}:
  3107      get:
  3108        summary: KMS get policy
  3109        operationId: KMSGetPolicy
  3110        parameters:
  3111          - name: name
  3112            description: KMS policy name
  3113            in: path
  3114            required: true
  3115            type: string
  3116        responses:
  3117          200:
  3118            description: A successful response.
  3119            schema:
  3120              $ref: "#/definitions/kmsGetPolicyResponse"
  3121          default:
  3122            description: Generic error response.
  3123            schema:
  3124              $ref: "#/definitions/ApiError"
  3125        tags:
  3126          - KMS
  3127      delete:
  3128        summary: KMS delete policy
  3129        operationId: KMSDeletePolicy
  3130        parameters:
  3131          - name: name
  3132            description: KMS policy name
  3133            in: path
  3134            required: true
  3135            type: string
  3136        responses:
  3137          200:
  3138            description: A successful response.
  3139          default:
  3140            description: Generic error response.
  3141            schema:
  3142              $ref: "#/definitions/ApiError"
  3143        tags:
  3144          - KMS
  3145    /kms/policies/{name}/assign:
  3146      post:
  3147        summary: KMS assign policy
  3148        operationId: KMSAssignPolicy
  3149        parameters:
  3150          - name: body
  3151            in: body
  3152            required: true
  3153            schema:
  3154              $ref: "#/definitions/kmsAssignPolicyRequest"
  3155          - name: name
  3156            description: KMS policy name
  3157            in: path
  3158            required: true
  3159            type: string
  3160        responses:
  3161          200:
  3162            description: A successful response.
  3163          default:
  3164            description: Generic error response.
  3165            schema:
  3166              $ref: "#/definitions/ApiError"
  3167        tags:
  3168          - KMS
  3169    /kms/policies/{name}/describe:
  3170      get:
  3171        summary: KMS describe policy
  3172        operationId: KMSDescribePolicy
  3173        parameters:
  3174          - name: name
  3175            description: KMS policy name
  3176            in: path
  3177            required: true
  3178            type: string
  3179        responses:
  3180          200:
  3181            description: A successful response.
  3182            schema:
  3183              $ref: "#/definitions/kmsDescribePolicyResponse"
  3184          default:
  3185            description: Generic error response.
  3186            schema:
  3187              $ref: "#/definitions/ApiError"
  3188        tags:
  3189          - KMS
  3190    /kms/identities/{name}:
  3191      delete:
  3192        summary: KMS delete identity
  3193        operationId: KMSDeleteIdentity
  3194        parameters:
  3195          - name: name
  3196            description: KMS identity name
  3197            in: path
  3198            required: true
  3199            type: string
  3200        responses:
  3201          200:
  3202            description: A successful response.
  3203          default:
  3204            description: Generic error response.
  3205            schema:
  3206              $ref: "#/definitions/ApiError"
  3207        tags:
  3208          - KMS
  3209    /kms/identities/{name}/describe:
  3210      get:
  3211        summary: KMS describe identity
  3212        operationId: KMSDescribeIdentity
  3213        parameters:
  3214          - name: name
  3215            description: KMS identity name
  3216            in: path
  3217            required: true
  3218            type: string
  3219        responses:
  3220          200:
  3221            description: A successful response.
  3222            schema:
  3223              $ref: "#/definitions/kmsDescribeIdentityResponse"
  3224          default:
  3225            description: Generic error response.
  3226            schema:
  3227              $ref: "#/definitions/ApiError"
  3228        tags:
  3229          - KMS
  3230    /kms/describe-self/identity:
  3231      get:
  3232        summary: KMS describe self identity
  3233        operationId: KMSDescribeSelfIdentity
  3234        responses:
  3235          200:
  3236            description: A successful response.
  3237            schema:
  3238              $ref: "#/definitions/kmsDescribeSelfIdentityResponse"
  3239          default:
  3240            description: Generic error response.
  3241            schema:
  3242              $ref: "#/definitions/ApiError"
  3243        tags:
  3244          - KMS
  3245    /kms/identities:
  3246      get:
  3247        summary: KMS list identities
  3248        operationId: KMSListIdentities
  3249        parameters:
  3250          - name: pattern
  3251            description: pattern to retrieve identities
  3252            in: query
  3253            type: string
  3254        responses:
  3255          200:
  3256            description: A successful response.
  3257            schema:
  3258              $ref: "#/definitions/kmsListIdentitiesResponse"
  3259          default:
  3260            description: Generic error response.
  3261            schema:
  3262              $ref: "#/definitions/ApiError"
  3263        tags:
  3264          - KMS
  3265  
  3266    /admin/inspect:
  3267      get:
  3268        summary: Inspect Files on Drive
  3269        operationId: Inspect
  3270        produces:
  3271          - application/octet-stream
  3272        parameters:
  3273          - name: file
  3274            in: query
  3275            required: true
  3276            type: string
  3277          - name: volume
  3278            in: query
  3279            required: true
  3280            type: string
  3281          - name: encrypt
  3282            in: query
  3283            required: false
  3284            type: boolean
  3285  
  3286        responses:
  3287          200:
  3288            description: A successful response.
  3289            schema:
  3290              type: file
  3291          default:
  3292            description: Generic error response.
  3293            schema:
  3294              $ref: "#/definitions/ApiError"
  3295        tags:
  3296          - Inspect
  3297    /idp/{type}:
  3298      post:
  3299        summary: Create IDP Configuration
  3300        operationId: CreateConfiguration
  3301        consumes:
  3302          - application/json
  3303        parameters:
  3304          - name: type
  3305            description: IDP Configuration Type
  3306            in: path
  3307            required: true
  3308            type: string
  3309          - name: body
  3310            in: body
  3311            required: true
  3312            schema:
  3313              $ref: "#/definitions/idpServerConfiguration"
  3314        responses:
  3315          201:
  3316            description: A successful response.
  3317            schema:
  3318              $ref: "#/definitions/setIDPResponse"
  3319          default:
  3320            description: Generic error response.
  3321            schema:
  3322              $ref: "#/definitions/ApiError"
  3323        tags:
  3324          - idp
  3325      get:
  3326        summary: List IDP Configurations
  3327        operationId: ListConfigurations
  3328        parameters:
  3329          - name: type
  3330            description: IDP Configuration Type
  3331            in: path
  3332            required: true
  3333            type: string
  3334        responses:
  3335          200:
  3336            description: A successful response.
  3337            schema:
  3338              $ref: "#/definitions/idpListConfigurationsResponse"
  3339          default:
  3340            description: Generic error response.
  3341            schema:
  3342              $ref: "#/definitions/ApiError"
  3343        tags:
  3344          - idp
  3345    /idp/{type}/{name}:
  3346      get:
  3347        summary: Get IDP Configuration
  3348        operationId: GetConfiguration
  3349        parameters:
  3350          - name: name
  3351            description: IDP Configuration Name
  3352            in: path
  3353            required: true
  3354            type: string
  3355          - name: type
  3356            description: IDP Configuration Type
  3357            in: path
  3358            required: true
  3359            type: string
  3360        responses:
  3361          200:
  3362            description: A successful response.
  3363            schema:
  3364              $ref: "#/definitions/idpServerConfiguration"
  3365          default:
  3366            description: Generic error response.
  3367            schema:
  3368              $ref: "#/definitions/ApiError"
  3369        tags:
  3370          - idp
  3371      delete:
  3372        summary: Delete IDP Configuration
  3373        operationId: DeleteConfiguration
  3374        parameters:
  3375          - name: name
  3376            description: IDP Configuration Name
  3377            in: path
  3378            required: true
  3379            type: string
  3380          - name: type
  3381            description: IDP Configuration Type
  3382            in: path
  3383            required: true
  3384            type: string
  3385        responses:
  3386          200:
  3387            description: A successful response.
  3388            schema:
  3389              $ref: "#/definitions/setIDPResponse"
  3390          default:
  3391            description: Generic error response.
  3392            schema:
  3393              $ref: "#/definitions/ApiError"
  3394        tags:
  3395          - idp
  3396      put:
  3397        summary: Update IDP Configuration
  3398        operationId: UpdateConfiguration
  3399        consumes:
  3400          - application/json
  3401        parameters:
  3402          - name: body
  3403            in: body
  3404            required: true
  3405            schema:
  3406              $ref: "#/definitions/idpServerConfiguration"
  3407          - name: name
  3408            description: IDP Configuration Name
  3409            in: path
  3410            required: true
  3411            type: string
  3412          - name: type
  3413            description: IDP Configuration Type
  3414            in: path
  3415            required: true
  3416            type: string
  3417        responses:
  3418          200:
  3419            description: A successful response.
  3420            schema:
  3421              $ref: "#/definitions/setIDPResponse"
  3422          default:
  3423            description: Generic error response.
  3424            schema:
  3425              $ref: "#/definitions/ApiError"
  3426        tags:
  3427          - idp
  3428  
  3429    /ldap-entities:
  3430      post:
  3431        summary: Get LDAP Entities
  3432        operationId: GetLDAPEntities
  3433        parameters:
  3434          - name: body
  3435            in: body
  3436            required: true
  3437            schema:
  3438              $ref: "#/definitions/ldapEntitiesRequest"
  3439        responses:
  3440          200:
  3441            description: A successful response.
  3442            schema:
  3443              $ref: "#/definitions/ldapEntities"
  3444          default:
  3445            description: Generic error response.
  3446            schema:
  3447              $ref: "#/definitions/ApiError"
  3448        tags:
  3449          - idp
  3450  
  3451    /releases:
  3452      get:
  3453        summary: Get repo releases for a given version
  3454        operationId: ListReleases
  3455        parameters:
  3456          - name: repo
  3457            description: repo name
  3458            in: query
  3459            type: string
  3460            required: true
  3461          - name: current
  3462            description: Current Release
  3463            in: query
  3464            type: string
  3465          - name: search
  3466            description: search content
  3467            in: query
  3468            type: string
  3469          - name: filter
  3470            description: filter releases
  3471            in: query
  3472            type: string
  3473        responses:
  3474          200:
  3475            description: A successful response.
  3476            schema:
  3477              $ref: "#/definitions/releaseListResponse"
  3478          default:
  3479            description: Generic error response.
  3480            schema:
  3481              $ref: "#/definitions/ApiError"
  3482        tags:
  3483          - release
  3484  
  3485    /support/callhome:
  3486      get:
  3487        summary: Get Callhome current status
  3488        operationId: GetCallHomeOptionValue
  3489        responses:
  3490          200:
  3491            description: A successful response.
  3492            schema:
  3493              $ref: "#/definitions/callHomeGetResponse"
  3494          default:
  3495            description: Generic error response.
  3496            schema:
  3497              $ref: "#/definitions/ApiError"
  3498        tags:
  3499          - Support
  3500  
  3501      put:
  3502        summary: Sets callhome status
  3503        operationId: SetCallHomeStatus
  3504        parameters:
  3505          - name: body
  3506            in: body
  3507            required: true
  3508            schema:
  3509              $ref: "#/definitions/callHomeSetStatus"
  3510        responses:
  3511          204:
  3512            description: A successful response.
  3513          default:
  3514            description: Generic error response.
  3515            schema:
  3516              $ref: "#/definitions/ApiError"
  3517        tags:
  3518          - Support
  3519  
  3520    /download-shared-object/{url}:
  3521      get:
  3522        summary: Downloads an object from a presigned url
  3523        operationId: DownloadSharedObject
  3524        security: []
  3525        produces:
  3526          - application/octet-stream
  3527        parameters:
  3528          - name: url
  3529            in: path
  3530            required: true
  3531            type: string
  3532        responses:
  3533          200:
  3534            description: A successful response.
  3535            schema:
  3536              type: file
  3537          default:
  3538            description: Generic error response.
  3539            schema:
  3540              $ref: "#/definitions/ApiError"
  3541        tags:
  3542          - Public
  3543  
  3544  definitions:
  3545    accountChangePasswordRequest:
  3546      type: object
  3547      required:
  3548        - current_secret_key
  3549        - new_secret_key
  3550      properties:
  3551        current_secret_key:
  3552          type: string
  3553        new_secret_key:
  3554          type: string
  3555  
  3556    changeUserPasswordRequest:
  3557      type: object
  3558      required:
  3559        - selectedUser
  3560        - newSecretKey
  3561      properties:
  3562        selectedUser:
  3563          type: string
  3564        newSecretKey:
  3565          type: string
  3566  
  3567    bucketEncryptionType:
  3568      type: string
  3569      enum:
  3570        - sse-s3
  3571        - sse-kms
  3572      default: sse-s3
  3573  
  3574    bucketAccess:
  3575      type: string
  3576      enum:
  3577        - PRIVATE
  3578        - PUBLIC
  3579        - CUSTOM
  3580      default: PRIVATE
  3581  
  3582    userServiceAccountItem:
  3583      type: object
  3584      properties:
  3585        userName:
  3586          type: string
  3587        numSAs:
  3588          type: integer
  3589          format: int64
  3590  
  3591    bucket:
  3592      type: object
  3593      required:
  3594        - name
  3595      properties:
  3596        name:
  3597          type: string
  3598          minLength: 3
  3599        size:
  3600          type: integer
  3601          format: int64
  3602        access:
  3603          $ref: "#/definitions/bucketAccess"
  3604        definition:
  3605          type: string
  3606        rw_access:
  3607          type: object
  3608          properties:
  3609            write:
  3610              type: boolean
  3611            read:
  3612              type: boolean
  3613        objects:
  3614          type: integer
  3615          format: int64
  3616        details:
  3617          type: object
  3618          properties:
  3619            versioning:
  3620              type: boolean
  3621            versioningSuspended:
  3622              type: boolean
  3623            locking:
  3624              type: boolean
  3625            replication:
  3626              type: boolean
  3627            tags:
  3628              type: object
  3629              additionalProperties:
  3630                type: string
  3631            quota:
  3632              type: object
  3633              properties:
  3634                quota:
  3635                  type: integer
  3636                  format: int64
  3637                type:
  3638                  type: string
  3639                  enum:
  3640                    - hard
  3641        creation_date:
  3642          type: string
  3643  
  3644    bucketEncryptionRequest:
  3645      type: object
  3646      properties:
  3647        encType:
  3648          $ref: "#/definitions/bucketEncryptionType"
  3649        kmsKeyID:
  3650          type: string
  3651  
  3652    bucketEncryptionInfo:
  3653      type: object
  3654      properties:
  3655        kmsMasterKeyID:
  3656          type: string
  3657        algorithm:
  3658          type: string
  3659  
  3660    listBucketsResponse:
  3661      type: object
  3662      properties:
  3663        buckets:
  3664          type: array
  3665          items:
  3666            $ref: "#/definitions/bucket"
  3667          title: list of resulting buckets
  3668        total:
  3669          type: integer
  3670          format: int64
  3671          title: number of buckets accessible to the user
  3672  
  3673    userServiceAccountSummary:
  3674      type: object
  3675      properties:
  3676        userServiceAccountList:
  3677          type: array
  3678          items:
  3679            $ref: "#/definitions/userServiceAccountItem"
  3680          title: list of users with number of service accounts
  3681        hasSA:
  3682          type: boolean
  3683  
  3684    listObjectsResponse:
  3685      type: object
  3686      properties:
  3687        objects:
  3688          type: array
  3689          items:
  3690            $ref: "#/definitions/bucketObject"
  3691          title: list of resulting objects
  3692        total:
  3693          type: integer
  3694          format: int64
  3695          title: number of objects
  3696  
  3697    bucketObject:
  3698      type: object
  3699      properties:
  3700        name:
  3701          type: string
  3702        size:
  3703          type: integer
  3704          format: int64
  3705        content_type:
  3706          type: string
  3707        last_modified:
  3708          type: string
  3709        is_latest:
  3710          type: boolean
  3711        is_delete_marker:
  3712          type: boolean
  3713        version_id:
  3714          type: string
  3715        user_tags:
  3716          type: object
  3717          additionalProperties:
  3718            type: string
  3719        expiration:
  3720          type: string
  3721        expiration_rule_id:
  3722          type: string
  3723        legal_hold_status:
  3724          type: string
  3725        retention_mode:
  3726          type: string
  3727        retention_until_date:
  3728          type: string
  3729        etag:
  3730          type: string
  3731        tags:
  3732          type: object
  3733          additionalProperties:
  3734            type: string
  3735        metadata:
  3736          type: object
  3737          additionalProperties:
  3738            type: string
  3739        user_metadata:
  3740          type: object
  3741          additionalProperties:
  3742            type: string
  3743  
  3744    makeBucketRequest:
  3745      type: object
  3746      required:
  3747        - name
  3748      properties:
  3749        name:
  3750          type: string
  3751        locking:
  3752          type: boolean
  3753        versioning:
  3754          $ref: "#/definitions/setBucketVersioning"
  3755        quota:
  3756          $ref: "#/definitions/setBucketQuota"
  3757        retention:
  3758          $ref: "#/definitions/putBucketRetentionRequest"
  3759    ApiError:
  3760      type: object
  3761      properties:
  3762        message:
  3763          type: string
  3764        detailedMessage:
  3765          type: string
  3766    user:
  3767      type: object
  3768      properties:
  3769        accessKey:
  3770          type: string
  3771        policy:
  3772          type: array
  3773          items:
  3774            type: string
  3775        memberOf:
  3776          type: array
  3777          items:
  3778            type: string
  3779        status:
  3780          type: string
  3781        hasPolicy:
  3782          type: boolean
  3783  
  3784    listUsersResponse:
  3785      type: object
  3786      properties:
  3787        users:
  3788          type: array
  3789          items:
  3790            $ref: "#/definitions/user"
  3791          title: list of resulting users
  3792    selectedUsers:
  3793      type: array
  3794      items:
  3795        type: string
  3796    addUserRequest:
  3797      type: object
  3798      required:
  3799        - accessKey
  3800        - secretKey
  3801        - groups
  3802        - policies
  3803      properties:
  3804        accessKey:
  3805          type: string
  3806        secretKey:
  3807          type: string
  3808        groups:
  3809          type: array
  3810          items:
  3811            type: string
  3812        policies:
  3813          type: array
  3814          items:
  3815            type: string
  3816    group:
  3817      type: object
  3818      properties:
  3819        name:
  3820          type: string
  3821        status:
  3822          type: string
  3823        members:
  3824          type: array
  3825          items:
  3826            type: string
  3827        policy:
  3828          type: string
  3829    addGroupRequest:
  3830      type: object
  3831      required:
  3832        - group
  3833        - members
  3834      properties:
  3835        group:
  3836          type: string
  3837        members:
  3838          type: array
  3839          items:
  3840            type: string
  3841    listGroupsResponse:
  3842      type: object
  3843      properties:
  3844        groups:
  3845          type: array
  3846          items:
  3847            type: string
  3848          title: list of groups
  3849        total:
  3850          type: integer
  3851          format: int64
  3852          title: total number of groups
  3853    policy:
  3854      type: object
  3855      properties:
  3856        name:
  3857          type: string
  3858        policy:
  3859          type: string
  3860    policyEntity:
  3861      type: string
  3862      enum:
  3863        - user
  3864        - group
  3865      default: user
  3866    setPolicyRequest:
  3867      type: object
  3868      required:
  3869        - entityType
  3870        - entityName
  3871      properties:
  3872        entityType:
  3873          $ref: "#/definitions/policyEntity"
  3874        entityName:
  3875          type: string
  3876  
  3877    setPolicyNameRequest:
  3878      type: object
  3879      required:
  3880        - name
  3881        - entityType
  3882        - entityName
  3883      properties:
  3884        name:
  3885          type: array
  3886          items:
  3887            type: string
  3888        entityType:
  3889          $ref: "#/definitions/policyEntity"
  3890        entityName:
  3891          type: string
  3892  
  3893    setPolicyMultipleNameRequest:
  3894      type: object
  3895      properties:
  3896        name:
  3897          type: array
  3898          items:
  3899            type: string
  3900        users:
  3901          type: array
  3902          items:
  3903            $ref: "#/definitions/iamEntity"
  3904        groups:
  3905          type: array
  3906          items:
  3907            $ref: "#/definitions/iamEntity"
  3908  
  3909    iamEntity:
  3910      type: string
  3911      pattern: '^[\w+=,.@-]{1,64}$'
  3912  
  3913    addPolicyRequest:
  3914      type: object
  3915      required:
  3916        - name
  3917        - policy
  3918      properties:
  3919        name:
  3920          type: string
  3921        policy:
  3922          type: string
  3923  
  3924    updateServiceAccountRequest:
  3925      type: object
  3926      required:
  3927        - policy
  3928      properties:
  3929        policy:
  3930          type: string
  3931        secretKey:
  3932          type: string
  3933        name:
  3934          type: string
  3935        description:
  3936          type: string
  3937        expiry:
  3938          type: string
  3939        status:
  3940          type: string
  3941  
  3942    listPoliciesResponse:
  3943      type: object
  3944      properties:
  3945        policies:
  3946          type: array
  3947          items:
  3948            $ref: "#/definitions/policy"
  3949          title: list of policies
  3950        total:
  3951          type: integer
  3952          format: int64
  3953          title: total number of policies
  3954  
  3955    listAccessRulesResponse:
  3956      type: object
  3957      properties:
  3958        accessRules:
  3959          type: array
  3960          items:
  3961            $ref: "#/definitions/accessRule"
  3962          title: list of policies
  3963        total:
  3964          type: integer
  3965          format: int64
  3966          title: total number of policies
  3967  
  3968    accessRule:
  3969      type: object
  3970      properties:
  3971        prefix:
  3972          type: string
  3973        access:
  3974          type: string
  3975  
  3976    updateGroupRequest:
  3977      type: object
  3978      required:
  3979        - members
  3980        - status
  3981      properties:
  3982        members:
  3983          type: array
  3984          items:
  3985            type: string
  3986        status:
  3987          type: string
  3988    configDescription:
  3989      type: object
  3990      properties:
  3991        key:
  3992          type: string
  3993        description:
  3994          type: string
  3995    configurationKV:
  3996      type: object
  3997      properties:
  3998        key:
  3999          type: string
  4000        value:
  4001          type: string
  4002        env_override:
  4003          $ref: "#/definitions/envOverride"
  4004    envOverride:
  4005      type: object
  4006      properties:
  4007        name:
  4008          type: string
  4009        value:
  4010          type: string
  4011    configuration:
  4012      type: object
  4013      properties:
  4014        name:
  4015          type: string
  4016        key_values:
  4017          type: array
  4018          items:
  4019            $ref: "#/definitions/configurationKV"
  4020    listConfigResponse:
  4021      type: object
  4022      properties:
  4023        configurations:
  4024          type: array
  4025          items:
  4026            $ref: "#/definitions/configDescription"
  4027        total:
  4028          type: integer
  4029          format: int64
  4030          title: total number of configurations
  4031    setConfigRequest:
  4032      type: object
  4033      required:
  4034        - key_values
  4035      properties:
  4036        key_values:
  4037          type: array
  4038          minItems: 1
  4039          items:
  4040            $ref: "#/definitions/configurationKV"
  4041        arn_resource_id:
  4042          type: string
  4043          title: Used if configuration is an event notification's target
  4044    notificationEventType:
  4045      type: string
  4046      enum:
  4047        - put
  4048        - delete
  4049        - get
  4050        - replica
  4051        - ilm
  4052        - scanner
  4053    notificationConfig:
  4054      type: object
  4055      required:
  4056        - arn
  4057      properties:
  4058        id:
  4059          type: string
  4060        arn:
  4061          type: string
  4062        events:
  4063          type: array
  4064          items:
  4065            $ref: "#/definitions/notificationEventType"
  4066          title: "filter specific type of event. Defaults to all event (default: '[put,delete,get]')"
  4067        prefix:
  4068          type: string
  4069          title: "filter event associated to the specified prefix"
  4070        suffix:
  4071          type: string
  4072          title: "filter event associated to the specified suffix"
  4073    notificationDeleteRequest:
  4074      type: object
  4075      required:
  4076        - events
  4077        - prefix
  4078        - suffix
  4079      properties:
  4080        events:
  4081          type: array
  4082          minLength: 1
  4083          items:
  4084            $ref: "#/definitions/notificationEventType"
  4085          title: "filter specific type of event. Defaults to all event (default: '[put,delete,get]')"
  4086        prefix:
  4087          type: string
  4088          title: "filter event associated to the specified prefix"
  4089        suffix:
  4090          type: string
  4091          title: "filter event associated to the specified suffix"
  4092    bucketEventRequest:
  4093      type: object
  4094      required:
  4095        - configuration
  4096      properties:
  4097        configuration:
  4098          $ref: "#/definitions/notificationConfig"
  4099        ignoreExisting:
  4100          type: boolean
  4101    bucketReplicationDestination:
  4102      type: object
  4103      properties:
  4104        bucket:
  4105          type: string
  4106    bucketReplicationRule:
  4107      type: object
  4108      properties:
  4109        id:
  4110          type: string
  4111        status:
  4112          type: string
  4113          enum:
  4114            - Enabled
  4115            - Disabled
  4116        priority:
  4117          type: integer
  4118          format: int32
  4119        syncMode:
  4120          type: string
  4121          enum:
  4122            - async
  4123            - sync
  4124          default: async
  4125        bandwidth:
  4126          type: string
  4127        healthCheckPeriod:
  4128          type: integer
  4129        delete_marker_replication:
  4130          type: boolean
  4131        deletes_replication:
  4132          type: boolean
  4133        existingObjects:
  4134          type: boolean
  4135        metadata_replication:
  4136          type: boolean
  4137        prefix:
  4138          type: string
  4139        tags:
  4140          type: string
  4141        storageClass:
  4142          type: string
  4143        destination:
  4144          $ref: "#/definitions/bucketReplicationDestination"
  4145  
  4146    bucketReplicationRuleList:
  4147      type: object
  4148      properties:
  4149        rules:
  4150          type: array
  4151          items:
  4152            type: string
  4153  
  4154    bucketReplicationResponse:
  4155      type: object
  4156      properties:
  4157        rules:
  4158          type: array
  4159          items:
  4160            $ref: "#/definitions/bucketReplicationRule"
  4161      # missing
  4162      #  "Filter": {
  4163      #   "And": {},
  4164      #   "Tag": {}
  4165      #  }
  4166      # }
  4167      #}
  4168  
  4169    listExternalBucketsParams:
  4170      required:
  4171        - accessKey
  4172        - secretKey
  4173        - targetURL
  4174        - useTLS
  4175      properties:
  4176        accessKey:
  4177          type: string
  4178          minLength: 3
  4179        secretKey:
  4180          type: string
  4181          minLength: 8
  4182        targetURL:
  4183          type: string
  4184        useTLS:
  4185          type: boolean
  4186        region:
  4187          type: string
  4188  
  4189    multiBucketReplication:
  4190      required:
  4191        - accessKey
  4192        - secretKey
  4193        - targetURL
  4194        - bucketsRelation
  4195      properties:
  4196        accessKey:
  4197          type: string
  4198          minLength: 3
  4199        secretKey:
  4200          type: string
  4201          minLength: 8
  4202        targetURL:
  4203          type: string
  4204        region:
  4205          type: string
  4206        syncMode:
  4207          type: string
  4208          enum:
  4209            - async
  4210            - sync
  4211          default: async
  4212        bandwidth:
  4213          type: integer
  4214          format: int64
  4215        healthCheckPeriod:
  4216          type: integer
  4217          format: int32
  4218        prefix:
  4219          type: string
  4220        tags:
  4221          type: string
  4222        replicateDeleteMarkers:
  4223          type: boolean
  4224        replicateDeletes:
  4225          type: boolean
  4226        replicateMetadata:
  4227          type: boolean
  4228        priority:
  4229          type: integer
  4230          format: int32
  4231          default: 0
  4232        storageClass:
  4233          type: string
  4234          default: ""
  4235        bucketsRelation:
  4236          type: array
  4237          minLength: 1
  4238          items:
  4239            $ref: "#/definitions/multiBucketsRelation"
  4240  
  4241    multiBucketReplicationEdit:
  4242      properties:
  4243        ruleState:
  4244          type: boolean
  4245        arn:
  4246          type: string
  4247        prefix:
  4248          type: string
  4249        tags:
  4250          type: string
  4251          default: ""
  4252        replicateDeleteMarkers:
  4253          type: boolean
  4254        replicateDeletes:
  4255          type: boolean
  4256        replicateMetadata:
  4257          type: boolean
  4258        replicateExistingObjects:
  4259          type: boolean
  4260        priority:
  4261          type: integer
  4262          format: int32
  4263          default: 0
  4264        storageClass:
  4265          type: string
  4266          default: ""
  4267  
  4268    multiBucketsRelation:
  4269      type: object
  4270      properties:
  4271        originBucket:
  4272          type: string
  4273        destinationBucket:
  4274          type: string
  4275  
  4276    multiBucketResponseItem:
  4277      type: object
  4278      properties:
  4279        originBucket:
  4280          type: string
  4281        targetBucket:
  4282          type: string
  4283        errorString:
  4284          type: string
  4285  
  4286    multiBucketResponseState:
  4287      type: object
  4288      properties:
  4289        replicationState:
  4290          type: array
  4291          items:
  4292            $ref: "#/definitions/multiBucketResponseItem"
  4293  
  4294    addBucketReplication:
  4295      type: object
  4296      properties:
  4297        arn:
  4298          type: string
  4299        destination_bucket:
  4300          type: string
  4301  
  4302    makeBucketsResponse:
  4303      type: object
  4304      properties:
  4305        bucketName:
  4306          type: string
  4307  
  4308    listBucketEventsResponse:
  4309      type: object
  4310      properties:
  4311        events:
  4312          type: array
  4313          items:
  4314            $ref: "#/definitions/notificationConfig"
  4315        total:
  4316          type: integer
  4317          format: int64
  4318          title: total number of bucket events
  4319    setBucketPolicyRequest:
  4320      type: object
  4321      required:
  4322        - access
  4323      properties:
  4324        access:
  4325          $ref: "#/definitions/bucketAccess"
  4326        definition:
  4327          type: string
  4328    bucketQuota:
  4329      type: object
  4330      properties:
  4331        quota:
  4332          type: integer
  4333        type:
  4334          type: string
  4335          enum:
  4336            - hard
  4337    setBucketQuota:
  4338      type: object
  4339      required:
  4340        - enabled
  4341      properties:
  4342        enabled:
  4343          type: boolean
  4344        quota_type:
  4345          type: string
  4346          enum:
  4347            - hard
  4348        amount:
  4349          type: integer
  4350    loginDetails:
  4351      type: object
  4352      properties:
  4353        loginStrategy:
  4354          type: string
  4355          enum: [form, redirect, service-account, redirect-service-account]
  4356        redirectRules:
  4357          type: array
  4358          items:
  4359            $ref: "#/definitions/redirectRule"
  4360        isK8S:
  4361          type: boolean
  4362        animatedLogin:
  4363          type: boolean
  4364    loginOauth2AuthRequest:
  4365      type: object
  4366      required:
  4367        - state
  4368        - code
  4369      properties:
  4370        state:
  4371          type: string
  4372        code:
  4373          type: string
  4374    loginRequest:
  4375      type: object
  4376      properties:
  4377        accessKey:
  4378          type: string
  4379        secretKey:
  4380          type: string
  4381        sts:
  4382          type: string
  4383        features:
  4384          type: object
  4385          properties:
  4386            hide_menu:
  4387              type: boolean
  4388    loginResponse:
  4389      type: object
  4390      properties:
  4391        sessionId:
  4392          type: string
  4393        IDPRefreshToken:
  4394          type: string
  4395    logoutRequest:
  4396      type: object
  4397      properties:
  4398        state:
  4399          type: string
  4400    # Structure that holds the `Bearer {TOKEN}` present on authenticated requests
  4401    principal:
  4402      type: object
  4403      properties:
  4404        STSAccessKeyID:
  4405          type: string
  4406        STSSecretAccessKey:
  4407          type: string
  4408        STSSessionToken:
  4409          type: string
  4410        accountAccessKey:
  4411          type: string
  4412        hm:
  4413          type: boolean
  4414        ob:
  4415          type: boolean
  4416        customStyleOb:
  4417          type: string
  4418    startProfilingItem:
  4419      type: object
  4420      properties:
  4421        nodeName:
  4422          type: string
  4423        success:
  4424          type: boolean
  4425        error:
  4426          type: string
  4427    startProfilingList:
  4428      type: object
  4429      properties:
  4430        total:
  4431          type: integer
  4432          format: int64
  4433          title: number of start results
  4434        startResults:
  4435          type: array
  4436          items:
  4437            $ref: "#/definitions/startProfilingItem"
  4438    profilingStartRequest:
  4439      type: object
  4440      required:
  4441        - type
  4442      properties:
  4443        type:
  4444          type: string
  4445    sessionResponse:
  4446      type: object
  4447      properties:
  4448        features:
  4449          type: array
  4450          items:
  4451            type: string
  4452        status:
  4453          type: string
  4454          enum: [ok]
  4455        operator:
  4456          type: boolean
  4457        distributedMode:
  4458          type: boolean
  4459        serverEndPoint:
  4460          type: string
  4461        permissions:
  4462          type: object
  4463          additionalProperties:
  4464            type: array
  4465            items:
  4466              type: string
  4467        customStyles:
  4468          type: string
  4469        allowResources:
  4470          type: array
  4471          items:
  4472            $ref: "#/definitions/permissionResource"
  4473        envConstants:
  4474          $ref: "#/definitions/environmentConstants"
  4475  
  4476    widgetResult:
  4477      type: object
  4478      properties:
  4479        metric:
  4480          type: object
  4481          additionalProperties:
  4482            type: string
  4483        values:
  4484          type: array
  4485          items: {}
  4486    resultTarget:
  4487      type: object
  4488      properties:
  4489        legendFormat:
  4490          type: string
  4491        resultType:
  4492          type: string
  4493        result:
  4494          type: array
  4495          items:
  4496            $ref: "#/definitions/widgetResult"
  4497    widget:
  4498      type: object
  4499      properties:
  4500        title:
  4501          type: string
  4502        type:
  4503          type: string
  4504        id:
  4505          type: integer
  4506          format: int32
  4507        options:
  4508          type: object
  4509          properties:
  4510            reduceOptions:
  4511              type: object
  4512              properties:
  4513                calcs:
  4514                  type: array
  4515                  items:
  4516                    type: string
  4517        targets:
  4518          type: array
  4519          items:
  4520            $ref: "#/definitions/resultTarget"
  4521    widgetDetails:
  4522      type: object
  4523      properties:
  4524        title:
  4525          type: string
  4526        type:
  4527          type: string
  4528        id:
  4529          type: integer
  4530          format: int32
  4531        options:
  4532          type: object
  4533          properties:
  4534            reduceOptions:
  4535              type: object
  4536              properties:
  4537                calcs:
  4538                  type: array
  4539                  items:
  4540                    type: string
  4541        targets:
  4542          type: array
  4543          items:
  4544            $ref: "#/definitions/resultTarget"
  4545    adminInfoResponse:
  4546      type: object
  4547      properties:
  4548        buckets:
  4549          type: integer
  4550        objects:
  4551          type: integer
  4552        usage:
  4553          type: integer
  4554        advancedMetricsStatus:
  4555          type: string
  4556          enum:
  4557            - not configured
  4558            - available
  4559            - unavailable
  4560        widgets:
  4561          type: array
  4562          items:
  4563            $ref: "#/definitions/widget"
  4564        servers:
  4565          type: array
  4566          items:
  4567            $ref: "#/definitions/serverProperties"
  4568        backend:
  4569          $ref: "#/definitions/BackendProperties"
  4570    serverProperties:
  4571      type: object
  4572      properties:
  4573        state:
  4574          type: string
  4575        endpoint:
  4576          type: string
  4577        uptime:
  4578          type: integer
  4579        version:
  4580          type: string
  4581        commitID:
  4582          type: string
  4583        poolNumber:
  4584          type: integer
  4585        network:
  4586          type: object
  4587          additionalProperties:
  4588            type: string
  4589        drives:
  4590          type: array
  4591          items:
  4592            $ref: "#/definitions/serverDrives"
  4593    serverDrives:
  4594      type: object
  4595      properties:
  4596        uuid:
  4597          type: string
  4598        state:
  4599          type: string
  4600        endpoint:
  4601          type: string
  4602        drivePath:
  4603          type: string
  4604        rootDisk:
  4605          type: boolean
  4606        healing:
  4607          type: boolean
  4608        model:
  4609          type: string
  4610        totalSpace:
  4611          type: integer
  4612        usedSpace:
  4613          type: integer
  4614        availableSpace:
  4615          type: integer
  4616    BackendProperties:
  4617      type: object
  4618      properties:
  4619        backendType:
  4620          type: string
  4621        rrSCParity:
  4622          type: integer
  4623        standardSCParity:
  4624          type: integer
  4625        onlineDrives:
  4626          type: integer
  4627        offlineDrives:
  4628          type: integer
  4629    arnsResponse:
  4630      type: object
  4631      properties:
  4632        arns:
  4633          type: array
  4634          items:
  4635            type: string
  4636    updateUserGroups:
  4637      type: object
  4638      required:
  4639        - groups
  4640      properties:
  4641        groups:
  4642          type: array
  4643          items:
  4644            type: string
  4645    nofiticationService:
  4646      type: string
  4647      enum:
  4648        - webhook
  4649        - amqp
  4650        - kafka
  4651        - mqtt
  4652        - nats
  4653        - nsq
  4654        - mysql
  4655        - postgres
  4656        - elasticsearch
  4657        - redis
  4658    notificationEndpointItem:
  4659      type: object
  4660      properties:
  4661        service:
  4662          $ref: "#/definitions/nofiticationService"
  4663        account_id:
  4664          type: string
  4665        status:
  4666          type: string
  4667    notificationEndpoint:
  4668      type: object
  4669      required:
  4670        - service
  4671        - account_id
  4672        - properties
  4673      properties:
  4674        service:
  4675          $ref: "#/definitions/nofiticationService"
  4676        account_id:
  4677          type: string
  4678        properties:
  4679          type: object
  4680          additionalProperties:
  4681            type: string
  4682    setNotificationEndpointResponse:
  4683      type: object
  4684      required:
  4685        - service
  4686        - account_id
  4687        - properties
  4688      properties:
  4689        service:
  4690          $ref: "#/definitions/nofiticationService"
  4691        account_id:
  4692          type: string
  4693        properties:
  4694          type: object
  4695          additionalProperties:
  4696            type: string
  4697        restart:
  4698          type: boolean
  4699    notifEndpointResponse:
  4700      type: object
  4701      properties:
  4702        notification_endpoints:
  4703          type: array
  4704          items:
  4705            $ref: "#/definitions/notificationEndpointItem"
  4706  
  4707    peerSiteRemoveResponse:
  4708      type: object
  4709      properties:
  4710        status:
  4711          type: string
  4712        errorDetail:
  4713          type: string
  4714  
  4715    peerSiteEditResponse:
  4716      type: object
  4717      properties:
  4718        success:
  4719          type: boolean
  4720        status:
  4721          type: string
  4722        errorDetail:
  4723          type: string
  4724  
  4725    peerSite:
  4726      type: object
  4727      properties:
  4728        name:
  4729          type: string
  4730        endpoint:
  4731          type: string
  4732        accessKey:
  4733          type: string
  4734        secretKey:
  4735          type: string
  4736  
  4737    peerInfo:
  4738      type: object
  4739      properties:
  4740        endpoint:
  4741          type: string
  4742        name:
  4743          type: string
  4744        deploymentID:
  4745          type: string
  4746  
  4747    peerInfoRemove:
  4748      type: object
  4749      required:
  4750        - sites
  4751      properties:
  4752        all:
  4753          type: boolean
  4754        sites:
  4755          type: array
  4756          items:
  4757            type: string
  4758  
  4759    siteReplicationAddRequest:
  4760      type: array
  4761      items:
  4762        $ref: "#/definitions/peerSite"
  4763  
  4764    siteReplicationAddResponse:
  4765      type: object
  4766      properties:
  4767        success:
  4768          type: boolean
  4769        status:
  4770          type: string
  4771        errorDetail:
  4772          type: string
  4773        initialSyncErrorMessage:
  4774          type: string
  4775  
  4776    siteReplicationInfoResponse:
  4777      type: object
  4778      properties:
  4779        enabled:
  4780          type: boolean
  4781        name:
  4782          type: string
  4783        sites:
  4784          type: array
  4785          items:
  4786            $ref: "#/definitions/peerInfo"
  4787        serviceAccountAccessKey:
  4788          type: string
  4789  
  4790    siteReplicationStatusResponse:
  4791      type: object
  4792      properties:
  4793        enabled:
  4794          type: boolean
  4795        maxBuckets:
  4796          type: integer
  4797        maxUsers:
  4798          type: integer
  4799        maxGroups:
  4800          type: integer
  4801        maxPolicies:
  4802          type: integer
  4803        sites:
  4804          type: object
  4805        statsSummary:
  4806          type: object
  4807        bucketStats:
  4808          type: object
  4809        policyStats:
  4810          type: object
  4811        userStats:
  4812          type: object
  4813        groupStats:
  4814          type: object
  4815  
  4816    updateUser:
  4817      type: object
  4818      required:
  4819        - status
  4820        - groups
  4821      properties:
  4822        status:
  4823          type: string
  4824        groups:
  4825          type: array
  4826          items:
  4827            type: string
  4828    bulkUserGroups:
  4829      type: object
  4830      required:
  4831        - users
  4832        - groups
  4833      properties:
  4834        users:
  4835          type: array
  4836          items:
  4837            type: string
  4838        groups:
  4839          type: array
  4840          items:
  4841            type: string
  4842    serviceAccount:
  4843      type: object
  4844      properties:
  4845        parentUser:
  4846          type: string
  4847        accountStatus:
  4848          type: string
  4849        impliedPolicy:
  4850          type: boolean
  4851        policy:
  4852          type: string
  4853        name:
  4854          type: string
  4855        description:
  4856          type: string
  4857        expiration:
  4858          type: string
  4859    serviceAccounts:
  4860      type: array
  4861      items:
  4862        type: object
  4863        properties:
  4864          accountStatus:
  4865            type: string
  4866          name:
  4867            type: string
  4868          description:
  4869            type: string
  4870          expiration:
  4871            type: string
  4872          accessKey:
  4873            type: string
  4874  
  4875    serviceAccountRequest:
  4876      type: object
  4877      properties:
  4878        policy:
  4879          type: string
  4880          title: "policy to be applied to the Service Account if any"
  4881        name:
  4882          type: string
  4883        description:
  4884          type: string
  4885        expiry:
  4886          type: string
  4887        comment:
  4888          type: string
  4889    serviceAccountRequestCreds:
  4890      type: object
  4891      properties:
  4892        policy:
  4893          type: string
  4894          title: "policy to be applied to the Service Account if any"
  4895        accessKey:
  4896          type: string
  4897        secretKey:
  4898          type: string
  4899        name:
  4900          type: string
  4901        description:
  4902          type: string
  4903        expiry:
  4904          type: string
  4905        comment:
  4906          type: string
  4907    serviceAccountCreds:
  4908      type: object
  4909      properties:
  4910        accessKey:
  4911          type: string
  4912        secretKey:
  4913          type: string
  4914        url:
  4915          type: string
  4916    remoteBucket:
  4917      type: object
  4918      required:
  4919        - accessKey
  4920        - sourceBucket
  4921        - remoteARN
  4922      properties:
  4923        accessKey:
  4924          type: string
  4925          minLength: 3
  4926        secretKey:
  4927          type: string
  4928          minLength: 8
  4929        sourceBucket:
  4930          type: string
  4931        targetURL:
  4932          type: string
  4933        targetBucket:
  4934          type: string
  4935        remoteARN:
  4936          type: string
  4937        status:
  4938          type: string
  4939        service:
  4940          type: string
  4941          enum: [replication]
  4942        syncMode:
  4943          type: string
  4944        bandwidth:
  4945          type: integer
  4946          format: int64
  4947        healthCheckPeriod:
  4948          type: integer
  4949    createRemoteBucket:
  4950      required:
  4951        - accessKey
  4952        - secretKey
  4953        - targetURL
  4954        - sourceBucket
  4955        - targetBucket
  4956      properties:
  4957        accessKey:
  4958          type: string
  4959          minLength: 3
  4960        secretKey:
  4961          type: string
  4962          minLength: 8
  4963        targetURL:
  4964          type: string
  4965        sourceBucket:
  4966          type: string
  4967        targetBucket:
  4968          type: string
  4969        region:
  4970          type: string
  4971        syncMode:
  4972          type: string
  4973          enum:
  4974            - async
  4975            - sync
  4976          default: async
  4977        bandwidth:
  4978          type: integer
  4979          format: int64
  4980        healthCheckPeriod:
  4981          type: integer
  4982          format: int32
  4983    listRemoteBucketsResponse:
  4984      type: object
  4985      properties:
  4986        buckets:
  4987          type: array
  4988          items:
  4989            $ref: "#/definitions/remoteBucket"
  4990          title: list of remote buckets
  4991        total:
  4992          type: integer
  4993          format: int64
  4994          title: number of remote buckets accessible to user
  4995    bucketVersioningResponse:
  4996      type: object
  4997      properties:
  4998        status:
  4999          type: string
  5000        MFADelete:
  5001          type: string
  5002        excludedPrefixes:
  5003          type: array
  5004          items:
  5005            type: object
  5006            properties:
  5007              prefix:
  5008                type: string
  5009        excludeFolders:
  5010          type: boolean
  5011  
  5012    setBucketVersioning:
  5013      type: object
  5014      properties:
  5015        enabled:
  5016          type: boolean
  5017        excludePrefixes:
  5018          type: array
  5019          maxLength: 10
  5020          items:
  5021            type: string
  5022        excludeFolders:
  5023          type: boolean
  5024  
  5025    bucketObLockingResponse:
  5026      type: object
  5027      properties:
  5028        object_locking_enabled:
  5029          type: boolean
  5030  
  5031    logSearchResponse:
  5032      type: object
  5033      properties:
  5034        results:
  5035          type: object
  5036          title: list of log search responses
  5037  
  5038    objectLegalHoldStatus:
  5039      type: string
  5040      enum:
  5041        - enabled
  5042        - disabled
  5043  
  5044    putObjectLegalHoldRequest:
  5045      type: object
  5046      required:
  5047        - status
  5048      properties:
  5049        status:
  5050          $ref: "#/definitions/objectLegalHoldStatus"
  5051  
  5052    objectRetentionMode:
  5053      type: string
  5054      enum:
  5055        - governance
  5056        - compliance
  5057  
  5058    putObjectRetentionRequest:
  5059      type: object
  5060      required:
  5061        - mode
  5062        - expires
  5063      properties:
  5064        mode:
  5065          $ref: "#/definitions/objectRetentionMode"
  5066        expires:
  5067          type: string
  5068        governance_bypass:
  5069          type: boolean
  5070  
  5071    putObjectTagsRequest:
  5072      type: object
  5073      properties:
  5074        tags:
  5075          additionalProperties:
  5076            type: string
  5077  
  5078    putBucketTagsRequest:
  5079      type: object
  5080      properties:
  5081        tags:
  5082          additionalProperties:
  5083            type: string
  5084  
  5085    objectRetentionUnit:
  5086      type: string
  5087      enum:
  5088        - days
  5089        - years
  5090  
  5091    putBucketRetentionRequest:
  5092      type: object
  5093      required:
  5094        - mode
  5095        - unit
  5096        - validity
  5097      properties:
  5098        mode:
  5099          $ref: "#/definitions/objectRetentionMode"
  5100        unit:
  5101          $ref: "#/definitions/objectRetentionUnit"
  5102        validity:
  5103          type: integer
  5104          format: int32
  5105  
  5106    getBucketRetentionConfig:
  5107      type: object
  5108      properties:
  5109        mode:
  5110          $ref: "#/definitions/objectRetentionMode"
  5111        unit:
  5112          $ref: "#/definitions/objectRetentionUnit"
  5113        validity:
  5114          type: integer
  5115          format: int32
  5116  
  5117    bucketLifecycleResponse:
  5118      type: object
  5119      properties:
  5120        lifecycle:
  5121          type: array
  5122          items:
  5123            $ref: "#/definitions/objectBucketLifecycle"
  5124  
  5125    expirationResponse:
  5126      type: object
  5127      properties:
  5128        date:
  5129          type: string
  5130        days:
  5131          type: integer
  5132          format: int64
  5133        delete_marker:
  5134          type: boolean
  5135        delete_all:
  5136          type: boolean
  5137        noncurrent_expiration_days:
  5138          type: integer
  5139          format: int64
  5140        newer_noncurrent_expiration_versions:
  5141          type: integer
  5142          format: int64
  5143  
  5144    transitionResponse:
  5145      type: object
  5146      properties:
  5147        date:
  5148          type: string
  5149        storage_class:
  5150          type: string
  5151        days:
  5152          type: integer
  5153          format: int64
  5154        noncurrent_transition_days:
  5155          type: integer
  5156          format: int64
  5157        noncurrent_storage_class:
  5158          type: string
  5159  
  5160    lifecycleTag:
  5161      type: object
  5162      properties:
  5163        key:
  5164          type: string
  5165        value:
  5166          type: string
  5167  
  5168    objectBucketLifecycle:
  5169      type: object
  5170      properties:
  5171        id:
  5172          type: string
  5173        prefix:
  5174          type: string
  5175        status:
  5176          type: string
  5177        expiration:
  5178          $ref: "#/definitions/expirationResponse"
  5179        transition:
  5180          $ref: "#/definitions/transitionResponse"
  5181        tags:
  5182          type: array
  5183          items:
  5184            $ref: "#/definitions/lifecycleTag"
  5185  
  5186    addBucketLifecycle:
  5187      type: object
  5188      properties:
  5189        type:
  5190          description: ILM Rule type (Expiry or transition)
  5191          type: string
  5192          enum:
  5193            - expiry
  5194            - transition
  5195        prefix:
  5196          description: Non required field, it matches a prefix to perform ILM operations on it
  5197          type: string
  5198        tags:
  5199          description: Non required field, tags to match ILM files
  5200          type: string
  5201        expiry_days:
  5202          description: Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM
  5203          type: integer
  5204          format: int32
  5205          default: 0
  5206        transition_days:
  5207          description: Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM
  5208          type: integer
  5209          format: int32
  5210          default: 0
  5211        storage_class:
  5212          description: Required only in case of transition is set. it refers to a tier
  5213          type: string
  5214        disable:
  5215          description: Non required, toggle to disable or enable rule
  5216          type: boolean
  5217        expired_object_delete_marker:
  5218          description: Non required, toggle to disable or enable rule
  5219          type: boolean
  5220        expired_object_delete_all:
  5221          description: Non required, toggle to disable or enable rule
  5222          type: boolean
  5223        noncurrentversion_expiration_days:
  5224          description: Non required, can be set in case of expiration is enabled
  5225          type: integer
  5226          format: int32
  5227          default: 0
  5228        noncurrentversion_transition_days:
  5229          description: Non required, can be set in case of transition is enabled
  5230          type: integer
  5231          format: int32
  5232          default: 0
  5233        newer_noncurrentversion_expiration_versions:
  5234          description: Non required, can be set in case of expiration is enabled
  5235          type: integer
  5236          format: int32
  5237          default: 0
  5238        noncurrentversion_transition_storage_class:
  5239          description: Non required, can be set in case of transition is enabled
  5240          type: string
  5241  
  5242    updateBucketLifecycle:
  5243      type: object
  5244      required:
  5245        - type
  5246      properties:
  5247        type:
  5248          description: ILM Rule type (Expiry or transition)
  5249          type: string
  5250          enum:
  5251            - expiry
  5252            - transition
  5253        prefix:
  5254          description: Non required field, it matches a prefix to perform ILM operations on it
  5255          type: string
  5256        tags:
  5257          description: Non required field, tags to match ILM files
  5258          type: string
  5259        expiry_days:
  5260          description: Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM
  5261          type: integer
  5262          format: int32
  5263          default: 0
  5264        transition_days:
  5265          description: Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM
  5266          type: integer
  5267          format: int32
  5268          default: 0
  5269        storage_class:
  5270          description: Required only in case of transition is set. it refers to a tier
  5271          type: string
  5272        disable:
  5273          description: Non required, toggle to disable or enable rule
  5274          type: boolean
  5275        expired_object_delete_marker:
  5276          description: Non required, toggle to disable or enable rule
  5277          type: boolean
  5278        expired_object_delete_all:
  5279          description: Non required, toggle to disable or enable rule
  5280          type: boolean
  5281        noncurrentversion_expiration_days:
  5282          description: Non required, can be set in case of expiration is enabled
  5283          type: integer
  5284          format: int32
  5285          default: 0
  5286        noncurrentversion_transition_days:
  5287          description: Non required, can be set in case of transition is enabled
  5288          type: integer
  5289          format: int32
  5290          default: 0
  5291        noncurrentversion_transition_storage_class:
  5292          description: Non required, can be set in case of transition is enabled
  5293          type: string
  5294  
  5295    addMultiBucketLifecycle:
  5296      type: object
  5297      required:
  5298        - buckets
  5299        - type
  5300      properties:
  5301        buckets:
  5302          type: array
  5303          items:
  5304            type: string
  5305        type:
  5306          description: ILM Rule type (Expiry or transition)
  5307          type: string
  5308          enum:
  5309            - expiry
  5310            - transition
  5311        prefix:
  5312          description: Non required field, it matches a prefix to perform ILM operations on it
  5313          type: string
  5314        tags:
  5315          description: Non required field, tags to match ILM files
  5316          type: string
  5317        expiry_days:
  5318          description: Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM
  5319          type: integer
  5320          format: int32
  5321          default: 0
  5322        transition_days:
  5323          description: Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM
  5324          type: integer
  5325          format: int32
  5326          default: 0
  5327        storage_class:
  5328          description: Required only in case of transition is set. it refers to a tier
  5329          type: string
  5330        expired_object_delete_marker:
  5331          description: Non required, toggle to disable or enable rule
  5332          type: boolean
  5333        expired_object_delete_all:
  5334          description: Non required, toggle to disable or enable rule
  5335          type: boolean
  5336        noncurrentversion_expiration_days:
  5337          description: Non required, can be set in case of expiration is enabled
  5338          type: integer
  5339          format: int32
  5340          default: 0
  5341        noncurrentversion_transition_days:
  5342          description: Non required, can be set in case of transition is enabled
  5343          type: integer
  5344          format: int32
  5345          default: 0
  5346        noncurrentversion_transition_storage_class:
  5347          description: Non required, can be set in case of transition is enabled
  5348          type: string
  5349  
  5350    multicycleResultItem:
  5351      type: object
  5352      properties:
  5353        bucketName:
  5354          type: string
  5355        error:
  5356          type: string
  5357  
  5358    multiLifecycleResult:
  5359      properties:
  5360        results:
  5361          type: array
  5362          items:
  5363            $ref: "#/definitions/multicycleResultItem"
  5364  
  5365    prefixAccessPair:
  5366      type: object
  5367      properties:
  5368        prefix:
  5369          type: string
  5370        access:
  5371          type: string
  5372  
  5373    prefixWrapper:
  5374      type: object
  5375      properties:
  5376        prefix:
  5377          type: string
  5378  
  5379    setConfigResponse:
  5380      type: object
  5381      properties:
  5382        restart:
  5383          description: Returns wheter server needs to restart to apply changes or not
  5384          type: boolean
  5385  
  5386    configExportResponse:
  5387      type: object
  5388      properties:
  5389        value:
  5390          description: Returns base64 encoded value
  5391          type: string
  5392        status:
  5393          type: string
  5394  
  5395    license:
  5396      type: object
  5397      properties:
  5398        email:
  5399          type: string
  5400        organization:
  5401          type: string
  5402        account_id:
  5403          type: integer
  5404        storage_capacity:
  5405          type: integer
  5406        plan:
  5407          type: string
  5408        expires_at:
  5409          type: string
  5410    apiKey:
  5411      type: object
  5412      properties:
  5413        apiKey:
  5414          type: string
  5415  
  5416    policyArgs:
  5417      type: object
  5418      properties:
  5419        id:
  5420          type: string
  5421        action:
  5422          type: string
  5423        bucket_name:
  5424          type: string
  5425  
  5426    tier_s3:
  5427      type: object
  5428      properties:
  5429        name:
  5430          type: string
  5431        endpoint:
  5432          type: string
  5433        accesskey:
  5434          type: string
  5435        secretkey:
  5436          type: string
  5437        bucket:
  5438          type: string
  5439        prefix:
  5440          type: string
  5441        region:
  5442          type: string
  5443        storageclass:
  5444          type: string
  5445        usage:
  5446          type: string
  5447        objects:
  5448          type: string
  5449        versions:
  5450          type: string
  5451  
  5452    tier_minio:
  5453      type: object
  5454      properties:
  5455        name:
  5456          type: string
  5457        endpoint:
  5458          type: string
  5459        accesskey:
  5460          type: string
  5461        secretkey:
  5462          type: string
  5463        bucket:
  5464          type: string
  5465        prefix:
  5466          type: string
  5467        region:
  5468          type: string
  5469        storageclass:
  5470          type: string
  5471        usage:
  5472          type: string
  5473        objects:
  5474          type: string
  5475        versions:
  5476          type: string
  5477  
  5478    tier_azure:
  5479      type: object
  5480      properties:
  5481        name:
  5482          type: string
  5483        endpoint:
  5484          type: string
  5485        accountname:
  5486          type: string
  5487        accountkey:
  5488          type: string
  5489        bucket:
  5490          type: string
  5491        prefix:
  5492          type: string
  5493        region:
  5494          type: string
  5495        usage:
  5496          type: string
  5497        objects:
  5498          type: string
  5499        versions:
  5500          type: string
  5501  
  5502    tier_gcs:
  5503      type: object
  5504      properties:
  5505        name:
  5506          type: string
  5507        endpoint:
  5508          type: string
  5509        creds:
  5510          type: string
  5511        bucket:
  5512          type: string
  5513        prefix:
  5514          type: string
  5515        region:
  5516          type: string
  5517        usage:
  5518          type: string
  5519        objects:
  5520          type: string
  5521        versions:
  5522          type: string
  5523  
  5524    deleteFile:
  5525      type: object
  5526      properties:
  5527        path:
  5528          type: string
  5529        versionID:
  5530          type: string
  5531        recursive:
  5532          type: boolean
  5533  
  5534    userSAs:
  5535      type: object
  5536      properties:
  5537        path:
  5538          type: string
  5539        versionID:
  5540          type: string
  5541        recursive:
  5542          type: boolean
  5543  
  5544    tier:
  5545      type: object
  5546      properties:
  5547        status:
  5548          type: boolean
  5549        type:
  5550          type: string
  5551          enum:
  5552            - s3
  5553            - gcs
  5554            - azure
  5555            - minio
  5556            - unsupported
  5557        s3:
  5558          type: object
  5559          $ref: "#/definitions/tier_s3"
  5560        gcs:
  5561          type: object
  5562          $ref: "#/definitions/tier_gcs"
  5563        azure:
  5564          type: object
  5565          $ref: "#/definitions/tier_azure"
  5566        minio:
  5567          type: object
  5568          $ref: "#/definitions/tier_minio"
  5569  
  5570    tierListResponse:
  5571      type: object
  5572      properties:
  5573        items:
  5574          type: array
  5575          items:
  5576            $ref: "#/definitions/tier"
  5577  
  5578    tierCredentialsRequest:
  5579      type: object
  5580      properties:
  5581        access_key:
  5582          type: string
  5583        secret_key:
  5584          type: string
  5585        creds:
  5586          type: string
  5587          description: a base64 encoded value
  5588  
  5589    rewindItem:
  5590      type: object
  5591      properties:
  5592        last_modified:
  5593          type: string
  5594        size:
  5595          type: integer
  5596          format: int64
  5597        version_id:
  5598          type: string
  5599        delete_flag:
  5600          type: boolean
  5601        action:
  5602          type: string
  5603        name:
  5604          type: string
  5605        is_latest:
  5606          type: boolean
  5607  
  5608    rewindResponse:
  5609      type: object
  5610      properties:
  5611        objects:
  5612          type: array
  5613          items:
  5614            $ref: "#/definitions/rewindItem"
  5615  
  5616    iamPolicy:
  5617      type: object
  5618      properties:
  5619        version:
  5620          type: string
  5621        statement:
  5622          type: array
  5623          items:
  5624            $ref: "#/definitions/iamPolicyStatement"
  5625  
  5626    iamPolicyStatement:
  5627      type: object
  5628      properties:
  5629        effect:
  5630          type: string
  5631        action:
  5632          type: array
  5633          items:
  5634            type: string
  5635        resource:
  5636          type: array
  5637          items:
  5638            type: string
  5639        condition:
  5640          type: object
  5641          additionalProperties:
  5642            type: object
  5643  
  5644    metadata:
  5645      type: object
  5646      properties:
  5647        objectMetadata:
  5648          type: object
  5649          additionalProperties: true
  5650  
  5651    subnetLoginResponse:
  5652      type: object
  5653      properties:
  5654        access_token:
  5655          type: string
  5656        organizations:
  5657          type: array
  5658          items:
  5659            $ref: "#/definitions/subnetOrganization"
  5660        mfa_token:
  5661          type: string
  5662        registered:
  5663          type: boolean
  5664  
  5665    subnetLoginRequest:
  5666      type: object
  5667      properties:
  5668        username:
  5669          type: string
  5670        password:
  5671          type: string
  5672        apiKey:
  5673          type: string
  5674  
  5675    subnetLoginMFARequest:
  5676      type: object
  5677      required:
  5678        - username
  5679        - otp
  5680        - mfa_token
  5681      properties:
  5682        username:
  5683          type: string
  5684        otp:
  5685          type: string
  5686        mfa_token:
  5687          type: string
  5688  
  5689    subnetRegisterRequest:
  5690      type: object
  5691      required:
  5692        - token
  5693        - account_id
  5694      properties:
  5695        token:
  5696          type: string
  5697        account_id:
  5698          type: string
  5699  
  5700    SubnetRegTokenResponse:
  5701      type: object
  5702      properties:
  5703        regToken:
  5704          type: string
  5705  
  5706    subnetOrganization:
  5707      type: object
  5708      properties:
  5709        userId:
  5710          type: integer
  5711        accountId:
  5712          type: integer
  5713        subscriptionStatus:
  5714          type: string
  5715        isAccountOwner:
  5716          type: boolean
  5717        company:
  5718          type: string
  5719        shortName:
  5720          type: string
  5721  
  5722    permissionResource:
  5723      type: object
  5724      properties:
  5725        resource:
  5726          type: string
  5727        conditionOperator:
  5728          type: string
  5729        prefixes:
  5730          type: array
  5731          items:
  5732            type: string
  5733  
  5734    aUserPolicyResponse:
  5735      type: object
  5736      properties:
  5737        policy:
  5738          type: string
  5739  
  5740    kmsStatusResponse:
  5741      type: object
  5742      properties:
  5743        name:
  5744          type: string
  5745        defaultKeyID:
  5746          type: string
  5747        endpoints:
  5748          type: array
  5749          items:
  5750            $ref: "#/definitions/kmsEndpoint"
  5751    kmsEndpoint:
  5752      type: object
  5753      properties:
  5754        url:
  5755          type: string
  5756        status:
  5757          type: string
  5758  
  5759    kmsKeyStatusResponse:
  5760      type: object
  5761      properties:
  5762        keyID:
  5763          type: string
  5764        encryptionErr:
  5765          type: string
  5766        decryptionErr:
  5767          type: string
  5768    kmsCreateKeyRequest:
  5769      type: object
  5770      required:
  5771        - key
  5772      properties:
  5773        key:
  5774          type: string
  5775    kmsImportKeyRequest:
  5776      type: object
  5777      required:
  5778        - bytes
  5779      properties:
  5780        bytes:
  5781          type: string
  5782    kmDeleteKeyRequest:
  5783      type: object
  5784    kmsListKeysResponse:
  5785      type: object
  5786      properties:
  5787        results:
  5788          type: array
  5789          items:
  5790            $ref: "#/definitions/kmsKeyInfo"
  5791    kmsKeyInfo:
  5792      type: object
  5793      properties:
  5794        name:
  5795          type: string
  5796        createdAt:
  5797          type: string
  5798        createdBy:
  5799          type: string
  5800  
  5801    kmsGetPolicyResponse:
  5802      type: object
  5803      properties:
  5804        allow:
  5805          type: array
  5806          items:
  5807            type: string
  5808        deny:
  5809          type: array
  5810          items:
  5811            type: string
  5812    kmsSetPolicyRequest:
  5813      type: object
  5814      required:
  5815        - policy
  5816      properties:
  5817        policy:
  5818          type: string
  5819        allow:
  5820          type: array
  5821          items:
  5822            type: string
  5823        deny:
  5824          type: array
  5825          items:
  5826            type: string
  5827    kmsDescribePolicyResponse:
  5828      type: object
  5829      properties:
  5830        createdAt:
  5831          type: string
  5832        createdBy:
  5833          type: string
  5834        name:
  5835          type: string
  5836    kmsAssignPolicyRequest:
  5837      type: object
  5838      properties:
  5839        identity:
  5840          type: string
  5841    kmsListPoliciesResponse:
  5842      type: object
  5843      properties:
  5844        results:
  5845          type: array
  5846          items:
  5847            $ref: "#/definitions/kmsPolicyInfo"
  5848    kmsPolicyInfo:
  5849      type: object
  5850      properties:
  5851        name:
  5852          type: string
  5853        createdAt:
  5854          type: string
  5855        createdBy:
  5856          type: string
  5857  
  5858    kmsDescribeIdentityResponse:
  5859      type: object
  5860      properties:
  5861        policy:
  5862          type: string
  5863        identity:
  5864          type: string
  5865        admin:
  5866          type: boolean
  5867        createdAt:
  5868          type: string
  5869        createdBy:
  5870          type: string
  5871    kmsDescribeSelfIdentityResponse:
  5872      type: object
  5873      properties:
  5874        identity:
  5875          type: string
  5876        policyName:
  5877          type: string
  5878        admin:
  5879          type: boolean
  5880        createdAt:
  5881          type: string
  5882        createdBy:
  5883          type: string
  5884        policy:
  5885          $ref: "#/definitions/kmsGetPolicyResponse"
  5886    kmsListIdentitiesResponse:
  5887      type: object
  5888      properties:
  5889        results:
  5890          type: array
  5891          items:
  5892            $ref: "#/definitions/kmsIdentityInfo"
  5893    kmsIdentityInfo:
  5894      type: object
  5895      properties:
  5896        identity:
  5897          type: string
  5898        policy:
  5899          type: string
  5900        error:
  5901          type: string
  5902        createdAt:
  5903          type: string
  5904        createdBy:
  5905          type: string
  5906    kmsMetricsResponse:
  5907      type: object
  5908      required:
  5909        - requestOK
  5910        - requestErr
  5911        - requestFail
  5912        - requestActive
  5913        - auditEvents
  5914        - errorEvents
  5915        - latencyHistogram
  5916        - uptime
  5917        - cpus
  5918        - usableCPUs
  5919        - threads
  5920        - heapAlloc
  5921        - stackAlloc
  5922      properties:
  5923        requestOK:
  5924          type: integer
  5925        requestErr:
  5926          type: integer
  5927        requestFail:
  5928          type: integer
  5929        requestActive:
  5930          type: integer
  5931        auditEvents:
  5932          type: integer
  5933        errorEvents:
  5934          type: integer
  5935        latencyHistogram:
  5936          type: array
  5937          items:
  5938            $ref: "#/definitions/kmsLatencyHistogram"
  5939        uptime:
  5940          type: integer
  5941        cpus:
  5942          type: integer
  5943        usableCPUs:
  5944          type: integer
  5945        threads:
  5946          type: integer
  5947        heapAlloc:
  5948          type: integer
  5949        heapObjects:
  5950          type: integer
  5951        stackAlloc:
  5952          type: integer
  5953    kmsLatencyHistogram:
  5954      type: object
  5955      properties:
  5956        duration:
  5957          type: integer
  5958        total:
  5959          type: integer
  5960  
  5961    kmsAPIsResponse:
  5962      type: object
  5963      properties:
  5964        results:
  5965          type: array
  5966          items:
  5967            $ref: "#/definitions/kmsAPI"
  5968    kmsAPI:
  5969      type: object
  5970      properties:
  5971        method:
  5972          type: string
  5973        path:
  5974          type: string
  5975        maxBody:
  5976          type: integer
  5977        timeout:
  5978          type: integer
  5979    kmsVersionResponse:
  5980      type: object
  5981      properties:
  5982        version:
  5983          type: string
  5984  
  5985    environmentConstants:
  5986      type: object
  5987      properties:
  5988        maxConcurrentUploads:
  5989          type: integer
  5990        maxConcurrentDownloads:
  5991          type: integer
  5992  
  5993    redirectRule:
  5994      type: object
  5995      properties:
  5996        redirect:
  5997          type: string
  5998        displayName:
  5999          type: string
  6000        serviceType:
  6001          type: string
  6002  
  6003    idpServerConfiguration:
  6004      type: object
  6005      properties:
  6006        name:
  6007          type: string
  6008        input:
  6009          type: string
  6010        type:
  6011          type: string
  6012        enabled:
  6013          type: boolean
  6014        info:
  6015          type: array
  6016          items:
  6017            $ref: "#/definitions/idpServerConfigurationInfo"
  6018    idpServerConfigurationInfo:
  6019      type: object
  6020      properties:
  6021        key:
  6022          type: string
  6023        value:
  6024          type: string
  6025        isCfg:
  6026          type: boolean
  6027        isEnv:
  6028          type: boolean
  6029    idpListConfigurationsResponse:
  6030      type: object
  6031      properties:
  6032        results:
  6033          type: array
  6034          items:
  6035            $ref: "#/definitions/idpServerConfiguration"
  6036    setIDPResponse:
  6037      type: object
  6038      properties:
  6039        restart:
  6040          type: boolean
  6041  
  6042    releaseListResponse:
  6043      type: object
  6044      properties:
  6045        results:
  6046          type: array
  6047          items:
  6048            $ref: "#/definitions/releaseInfo"
  6049    releaseInfo:
  6050      type: object
  6051      properties:
  6052        metadata:
  6053          $ref: "#/definitions/releaseMetadata"
  6054        notesContent:
  6055          type: string
  6056        securityContent:
  6057          type: string
  6058        breakingChangesContent:
  6059          type: string
  6060        contextContent:
  6061          type: string
  6062        newFeaturesContent:
  6063          type: string
  6064  
  6065    releaseMetadata:
  6066      type: object
  6067      properties:
  6068        tag_name:
  6069          type: string
  6070        target_commitish:
  6071          type: string
  6072        name:
  6073          type: string
  6074        draft:
  6075          type: boolean
  6076        prerelease:
  6077          type: boolean
  6078        id:
  6079          type: integer
  6080        created_at:
  6081          type: string
  6082        published_at:
  6083          type: string
  6084        url:
  6085          type: string
  6086        html_url:
  6087          type: string
  6088        assets_url:
  6089          type: string
  6090        upload_url:
  6091          type: string
  6092        zipball_url:
  6093          type: string
  6094        tarball_url:
  6095          type: string
  6096        author:
  6097          $ref: "#/definitions/releaseAuthor"
  6098        node_id:
  6099          type: string
  6100    releaseAuthor:
  6101      type: object
  6102      properties:
  6103        login:
  6104          type: string
  6105        id:
  6106          type: integer
  6107        node_id:
  6108          type: string
  6109        avatar_url:
  6110          type: string
  6111        html_url:
  6112          type: string
  6113        gravatar_id:
  6114          type: string
  6115        type:
  6116          type: string
  6117        site_admin:
  6118          type: boolean
  6119        url:
  6120          type: string
  6121        events_url:
  6122          type: string
  6123        following_url:
  6124          type: string
  6125        followers_url:
  6126          type: string
  6127        gists_url:
  6128          type: string
  6129        organizations_url:
  6130          type: string
  6131        receivedEvents_url:
  6132          type: string
  6133        repos_url:
  6134          type: string
  6135        starred_url:
  6136          type: string
  6137        subscriptions_url:
  6138          type: string
  6139  
  6140    callHomeGetResponse:
  6141      type: object
  6142      properties:
  6143        diagnosticsStatus:
  6144          type: boolean
  6145        logsStatus:
  6146          type: boolean
  6147  
  6148    callHomeSetStatus:
  6149      type: object
  6150      required:
  6151        - diagState
  6152        - logsState
  6153      properties:
  6154        diagState:
  6155          type: boolean
  6156        logsState:
  6157          type: boolean
  6158  
  6159    ldapEntitiesRequest:
  6160      type: object
  6161      properties:
  6162        users:
  6163          type: array
  6164          items:
  6165            type: string
  6166        groups:
  6167          type: array
  6168          items:
  6169            type: string
  6170        policies:
  6171          type: array
  6172          items:
  6173            type: string
  6174  
  6175    ldapEntities:
  6176      type: object
  6177      properties:
  6178        timestamp:
  6179          type: string
  6180        users:
  6181          type: array
  6182          items:
  6183            $ref: "#/definitions/ldapUserPolicyEntity"
  6184        groups:
  6185          type: array
  6186          items:
  6187            $ref: "#/definitions/ldapGroupPolicyEntity"
  6188        policies:
  6189          type: array
  6190          items:
  6191            $ref: "#/definitions/ldapPolicyEntity"
  6192  
  6193    ldapUserPolicyEntity:
  6194      type: object
  6195      properties:
  6196        user:
  6197          type: string
  6198        policies:
  6199          type: array
  6200          items:
  6201            type: string
  6202  
  6203    ldapGroupPolicyEntity:
  6204      type: object
  6205      properties:
  6206        group:
  6207          type: string
  6208        policies:
  6209          type: array
  6210          items:
  6211            type: string
  6212  
  6213    ldapPolicyEntity:
  6214      type: object
  6215      properties:
  6216        policy:
  6217          type: string
  6218        users:
  6219          type: array
  6220          items:
  6221            type: string
  6222        groups:
  6223          type: array
  6224          items:
  6225            type: string
  6226  
  6227    maxShareLinkExpResponse:
  6228      type: object
  6229      properties:
  6230        exp:
  6231          type: number
  6232          format: int64
  6233      required:
  6234        - exp
  6235  
  6236    selectedSAs:
  6237      type: array
  6238      items:
  6239        type: string