Files
object-browser/api/embedded_spec.go
2025-03-11 02:30:53 -07:00

8444 lines
177 KiB
Go

// Code generated by go-swagger; DO NOT EDIT.
// This file is part of MinIO Console Server
// Copyright (c) 2023 MinIO, Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
package api
// This file was generated by the swagger tool.
// Editing this file might prove futile when you re-run the swagger generate command
import (
"encoding/json"
)
var (
// SwaggerJSON embedded version of the swagger document used at generation time
SwaggerJSON json.RawMessage
// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
FlatSwaggerJSON json.RawMessage
)
func init() {
SwaggerJSON = json.RawMessage([]byte(`{
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"http",
"ws"
],
"swagger": "2.0",
"info": {
"title": "MinIO Console Server",
"version": "0.1.0"
},
"basePath": "/api/v1",
"paths": {
"/admin/info": {
"get": {
"tags": [
"System"
],
"summary": "Returns information about the deployment",
"operationId": "AdminInfo",
"parameters": [
{
"type": "boolean",
"default": false,
"name": "defaultOnly",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/adminInfoResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets": {
"get": {
"tags": [
"Bucket"
],
"summary": "List Buckets",
"operationId": "ListBuckets",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/listBucketsResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
},
"post": {
"tags": [
"Bucket"
],
"summary": "Make bucket",
"operationId": "MakeBucket",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/makeBucketRequest"
}
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/makeBucketsResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/max-share-exp": {
"get": {
"tags": [
"Bucket"
],
"summary": "Get max expiration time for share link in seconds",
"operationId": "GetMaxShareLinkExp",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/maxShareLinkExpResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/delete-objects": {
"post": {
"tags": [
"Object"
],
"summary": "Delete Multiple Objects",
"operationId": "DeleteMultipleObjects",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "boolean",
"name": "all_versions",
"in": "query"
},
{
"type": "boolean",
"name": "bypass",
"in": "query"
},
{
"name": "files",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/deleteFile"
}
}
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects": {
"get": {
"security": [
{
"key": []
},
{
"anonymous": []
}
],
"tags": [
"Object"
],
"summary": "List Objects",
"operationId": "ListObjects",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query"
},
{
"type": "boolean",
"name": "recursive",
"in": "query"
},
{
"type": "boolean",
"name": "with_versions",
"in": "query"
},
{
"type": "boolean",
"name": "with_metadata",
"in": "query"
},
{
"$ref": "#/parameters/limit"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/listObjectsResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
},
"delete": {
"tags": [
"Object"
],
"summary": "Delete Object",
"operationId": "DeleteObject",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query",
"required": true
},
{
"type": "string",
"name": "version_id",
"in": "query"
},
{
"type": "boolean",
"name": "recursive",
"in": "query"
},
{
"type": "boolean",
"name": "all_versions",
"in": "query"
},
{
"type": "boolean",
"name": "non_current_versions",
"in": "query"
},
{
"type": "boolean",
"name": "bypass",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/download": {
"get": {
"security": [
{
"key": []
},
{
"anonymous": []
}
],
"produces": [
"application/octet-stream"
],
"tags": [
"Object"
],
"summary": "Download Object",
"operationId": "Download Object",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query",
"required": true
},
{
"type": "string",
"name": "version_id",
"in": "query"
},
{
"type": "boolean",
"default": false,
"name": "preview",
"in": "query"
},
{
"type": "string",
"default": "",
"name": "override_file_name",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"type": "file"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/download-multiple": {
"post": {
"security": [
{
"key": []
},
{
"anonymous": []
}
],
"produces": [
"application/octet-stream"
],
"tags": [
"Object"
],
"summary": "Download Multiple Objects",
"operationId": "DownloadMultipleObjects",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"name": "objectList",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"type": "file"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/metadata": {
"get": {
"tags": [
"Object"
],
"summary": "Gets the metadata of an object",
"operationId": "GetObjectMetadata",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query",
"required": true
},
{
"type": "string",
"name": "versionID",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/metadata"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/restore": {
"put": {
"tags": [
"Object"
],
"summary": "Restore Object to a selected version",
"operationId": "PutObjectRestore",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query",
"required": true
},
{
"type": "string",
"name": "version_id",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/share": {
"get": {
"tags": [
"Object"
],
"summary": "Shares an Object on a url",
"operationId": "ShareObject",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query",
"required": true
},
{
"type": "string",
"name": "version_id",
"in": "query",
"required": true
},
{
"type": "string",
"name": "expires",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"type": "string"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/tags": {
"put": {
"tags": [
"Object"
],
"summary": "Put Object's tags",
"operationId": "PutObjectTags",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query",
"required": true
},
{
"type": "string",
"name": "version_id",
"in": "query",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/putObjectTagsRequest"
}
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/upload": {
"post": {
"security": [
{
"key": []
},
{
"anonymous": []
}
],
"consumes": [
"multipart/form-data"
],
"tags": [
"Object"
],
"summary": "Uploads an Object.",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/rewind/{date}": {
"get": {
"tags": [
"Bucket"
],
"summary": "Get objects in a bucket for a rewind date",
"operationId": "GetBucketRewind",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "date",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/rewindResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/tags": {
"put": {
"tags": [
"Bucket"
],
"summary": "Put Bucket's tags",
"operationId": "PutBucketTags",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/putBucketTagsRequest"
}
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/versioning": {
"get": {
"tags": [
"Bucket"
],
"summary": "Bucket Versioning",
"operationId": "GetBucketVersioning",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/bucketVersioningResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
},
"put": {
"tags": [
"Bucket"
],
"summary": "Set Bucket Versioning",
"operationId": "SetBucketVersioning",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/setBucketVersioning"
}
}
],
"responses": {
"201": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{name}": {
"get": {
"tags": [
"Bucket"
],
"summary": "Bucket Info",
"operationId": "BucketInfo",
"parameters": [
{
"type": "string",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/bucket"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{name}/quota": {
"get": {
"tags": [
"Bucket"
],
"summary": "Get Bucket Quota",
"operationId": "GetBucketQuota",
"parameters": [
{
"type": "string",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/bucketQuota"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/download-shared-object/{url}": {
"get": {
"security": [],
"produces": [
"application/octet-stream"
],
"tags": [
"Public"
],
"summary": "Downloads an object from a presigned url",
"operationId": "DownloadSharedObject",
"parameters": [
{
"type": "string",
"name": "url",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"type": "file"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/license/acknowledge": {
"get": {
"tags": [
"License"
],
"summary": "Acknowledge the license",
"operationId": "LicenseAcknowledge",
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/login": {
"get": {
"security": [],
"tags": [
"Auth"
],
"summary": "Returns login strategy, form or sso.",
"operationId": "LoginDetail",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/loginDetails"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
},
"post": {
"security": [],
"tags": [
"Auth"
],
"summary": "Login to Console",
"operationId": "Login",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/loginRequest"
}
}
],
"responses": {
"204": {
"description": "A successful login."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/login/oauth2/auth": {
"post": {
"security": [],
"tags": [
"Auth"
],
"summary": "Identity Provider oauth2 callback endpoint.",
"operationId": "LoginOauth2Auth",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/loginOauth2AuthRequest"
}
}
],
"responses": {
"204": {
"description": "A successful login."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/logout": {
"post": {
"tags": [
"Auth"
],
"summary": "Logout from Console.",
"operationId": "Logout",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/logoutRequest"
}
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/session": {
"get": {
"tags": [
"Auth"
],
"summary": "Endpoint to check if your session is still valid",
"operationId": "SessionCheck",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/sessionResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/users": {
"get": {
"tags": [
"User"
],
"summary": "List Users",
"operationId": "ListUsers",
"parameters": [
{
"$ref": "#/parameters/offset"
},
{
"$ref": "#/parameters/limit"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/listUsersResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
}
},
"definitions": {
"ApiError": {
"type": "object",
"properties": {
"detailedMessage": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"BackendProperties": {
"type": "object",
"properties": {
"backendType": {
"type": "string"
},
"offlineDrives": {
"type": "integer"
},
"onlineDrives": {
"type": "integer"
},
"rrSCParity": {
"type": "integer"
},
"standardSCParity": {
"type": "integer"
}
}
},
"aUserPolicyResponse": {
"type": "object",
"properties": {
"policy": {
"type": "string"
}
}
},
"accessRule": {
"type": "object",
"properties": {
"access": {
"type": "string"
},
"prefix": {
"type": "string"
}
}
},
"accountChangePasswordRequest": {
"type": "object",
"required": [
"current_secret_key",
"new_secret_key"
],
"properties": {
"current_secret_key": {
"type": "string"
},
"new_secret_key": {
"type": "string"
}
}
},
"addBucketReplication": {
"type": "object",
"properties": {
"arn": {
"type": "string"
},
"destination_bucket": {
"type": "string"
}
}
},
"addGroupRequest": {
"type": "object",
"required": [
"group",
"members"
],
"properties": {
"group": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"addPolicyRequest": {
"type": "object",
"required": [
"name",
"policy"
],
"properties": {
"name": {
"type": "string"
},
"policy": {
"type": "string"
}
}
},
"addUserRequest": {
"type": "object",
"required": [
"accessKey",
"secretKey",
"groups",
"policies"
],
"properties": {
"accessKey": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"policies": {
"type": "array",
"items": {
"type": "string"
}
},
"secretKey": {
"type": "string"
}
}
},
"adminInfoResponse": {
"type": "object",
"properties": {
"advancedMetricsStatus": {
"type": "string",
"enum": [
"not configured",
"available",
"unavailable"
]
},
"backend": {
"$ref": "#/definitions/BackendProperties"
},
"buckets": {
"type": "integer"
},
"objects": {
"type": "integer"
},
"servers": {
"type": "array",
"items": {
"$ref": "#/definitions/serverProperties"
}
},
"usage": {
"type": "integer"
},
"widgets": {
"type": "array",
"items": {
"$ref": "#/definitions/widget"
}
}
}
},
"apiKey": {
"type": "object",
"properties": {
"apiKey": {
"type": "string"
}
}
},
"arnsResponse": {
"type": "object",
"properties": {
"arns": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"bucket": {
"type": "object",
"required": [
"name"
],
"properties": {
"access": {
"$ref": "#/definitions/bucketAccess"
},
"creation_date": {
"type": "string"
},
"definition": {
"type": "string"
},
"details": {
"type": "object",
"properties": {
"locking": {
"type": "boolean"
},
"quota": {
"type": "object",
"properties": {
"quota": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string",
"enum": [
"hard"
]
}
}
},
"replication": {
"type": "boolean"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"versioning": {
"type": "boolean"
},
"versioningSuspended": {
"type": "boolean"
}
}
},
"name": {
"type": "string",
"minLength": 3
},
"objects": {
"type": "integer",
"format": "int64"
},
"rw_access": {
"type": "object",
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
}
},
"size": {
"type": "integer",
"format": "int64"
}
}
},
"bucketAccess": {
"type": "string",
"default": "PRIVATE",
"enum": [
"PRIVATE",
"PUBLIC",
"CUSTOM"
]
},
"bucketEncryptionInfo": {
"type": "object",
"properties": {
"algorithm": {
"type": "string"
},
"kmsMasterKeyID": {
"type": "string"
}
}
},
"bucketEncryptionRequest": {
"type": "object",
"properties": {
"encType": {
"$ref": "#/definitions/bucketEncryptionType"
},
"kmsKeyID": {
"type": "string"
}
}
},
"bucketEncryptionType": {
"type": "string",
"default": "sse-s3",
"enum": [
"sse-s3",
"sse-kms"
]
},
"bucketEventRequest": {
"type": "object",
"required": [
"configuration"
],
"properties": {
"configuration": {
"$ref": "#/definitions/notificationConfig"
},
"ignoreExisting": {
"type": "boolean"
}
}
},
"bucketObLockingResponse": {
"type": "object",
"properties": {
"object_locking_enabled": {
"type": "boolean"
}
}
},
"bucketObject": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"etag": {
"type": "string"
},
"expiration": {
"type": "string"
},
"expiration_rule_id": {
"type": "string"
},
"is_delete_marker": {
"type": "boolean"
},
"is_latest": {
"type": "boolean"
},
"last_modified": {
"type": "string"
},
"legal_hold_status": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"retention_mode": {
"type": "string"
},
"retention_until_date": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"user_metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"user_tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"version_id": {
"type": "string"
}
}
},
"bucketQuota": {
"type": "object",
"properties": {
"quota": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"hard"
]
}
}
},
"bucketReplicationDestination": {
"type": "object",
"properties": {
"bucket": {
"type": "string"
}
}
},
"bucketReplicationResponse": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/bucketReplicationRule"
}
}
}
},
"bucketReplicationRule": {
"type": "object",
"properties": {
"bandwidth": {
"type": "string"
},
"delete_marker_replication": {
"type": "boolean"
},
"deletes_replication": {
"type": "boolean"
},
"destination": {
"$ref": "#/definitions/bucketReplicationDestination"
},
"existingObjects": {
"type": "boolean"
},
"healthCheckPeriod": {
"type": "integer"
},
"id": {
"type": "string"
},
"metadata_replication": {
"type": "boolean"
},
"prefix": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"storageClass": {
"type": "string"
},
"syncMode": {
"type": "string",
"default": "async",
"enum": [
"async",
"sync"
]
},
"tags": {
"type": "string"
}
}
},
"bucketReplicationRuleList": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"bucketVersioningResponse": {
"type": "object",
"properties": {
"MFADelete": {
"type": "string"
},
"excludeFolders": {
"type": "boolean"
},
"excludedPrefixes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prefix": {
"type": "string"
}
}
}
},
"status": {
"type": "string"
}
}
},
"bulkUserGroups": {
"type": "object",
"required": [
"users",
"groups"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"users": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"callHomeGetResponse": {
"type": "object",
"properties": {
"diagnosticsStatus": {
"type": "boolean"
},
"logsStatus": {
"type": "boolean"
}
}
},
"callHomeSetStatus": {
"type": "object",
"required": [
"diagState",
"logsState"
],
"properties": {
"diagState": {
"type": "boolean"
},
"logsState": {
"type": "boolean"
}
}
},
"changeUserPasswordRequest": {
"type": "object",
"required": [
"selectedUser",
"newSecretKey"
],
"properties": {
"newSecretKey": {
"type": "string"
},
"selectedUser": {
"type": "string"
}
}
},
"configDescription": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"key": {
"type": "string"
}
}
},
"configExportResponse": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"value": {
"description": "Returns base64 encoded value",
"type": "string"
}
}
},
"configuration": {
"type": "object",
"properties": {
"key_values": {
"type": "array",
"items": {
"$ref": "#/definitions/configurationKV"
}
},
"name": {
"type": "string"
}
}
},
"configurationKV": {
"type": "object",
"properties": {
"env_override": {
"$ref": "#/definitions/envOverride"
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"createRemoteBucket": {
"required": [
"accessKey",
"secretKey",
"targetURL",
"sourceBucket",
"targetBucket"
],
"properties": {
"accessKey": {
"type": "string",
"minLength": 3
},
"bandwidth": {
"type": "integer",
"format": "int64"
},
"healthCheckPeriod": {
"type": "integer",
"format": "int32"
},
"region": {
"type": "string"
},
"secretKey": {
"type": "string",
"minLength": 8
},
"sourceBucket": {
"type": "string"
},
"syncMode": {
"type": "string",
"default": "async",
"enum": [
"async",
"sync"
]
},
"targetBucket": {
"type": "string"
},
"targetURL": {
"type": "string"
}
}
},
"deleteFile": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"recursive": {
"type": "boolean"
},
"versionID": {
"type": "string"
}
}
},
"envOverride": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"environmentConstants": {
"type": "object",
"properties": {
"maxConcurrentDownloads": {
"type": "integer"
},
"maxConcurrentUploads": {
"type": "integer"
}
}
},
"getBucketRetentionConfig": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/definitions/objectRetentionMode"
},
"unit": {
"$ref": "#/definitions/objectRetentionUnit"
},
"validity": {
"type": "integer",
"format": "int32"
}
}
},
"group": {
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"policy": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"iamEntity": {
"type": "string"
},
"iamPolicy": {
"type": "object",
"properties": {
"statement": {
"type": "array",
"items": {
"$ref": "#/definitions/iamPolicyStatement"
}
},
"version": {
"type": "string"
}
}
},
"iamPolicyStatement": {
"type": "object",
"properties": {
"action": {
"type": "array",
"items": {
"type": "string"
}
},
"condition": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"effect": {
"type": "string"
},
"resource": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"idpListConfigurationsResponse": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/idpServerConfiguration"
}
}
}
},
"idpServerConfiguration": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"info": {
"type": "array",
"items": {
"$ref": "#/definitions/idpServerConfigurationInfo"
}
},
"input": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"idpServerConfigurationInfo": {
"type": "object",
"properties": {
"isCfg": {
"type": "boolean"
},
"isEnv": {
"type": "boolean"
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"kmsAPI": {
"type": "object",
"properties": {
"maxBody": {
"type": "integer"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"timeout": {
"type": "integer"
}
}
},
"kmsAPIsResponse": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/kmsAPI"
}
}
}
},
"kmsCreateKeyRequest": {
"type": "object",
"required": [
"key"
],
"properties": {
"key": {
"type": "string"
}
}
},
"kmsEndpoint": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"kmsKeyInfo": {
"type": "object",
"properties": {
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"kmsKeyStatusResponse": {
"type": "object",
"properties": {
"decryptionErr": {
"type": "string"
},
"encryptionErr": {
"type": "string"
},
"keyID": {
"type": "string"
}
}
},
"kmsLatencyHistogram": {
"type": "object",
"properties": {
"duration": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"kmsListKeysResponse": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/kmsKeyInfo"
}
}
}
},
"kmsMetricsResponse": {
"type": "object",
"required": [
"requestOK",
"requestErr",
"requestFail",
"requestActive",
"auditEvents",
"errorEvents",
"latencyHistogram",
"uptime",
"cpus",
"usableCPUs",
"threads",
"heapAlloc",
"stackAlloc"
],
"properties": {
"auditEvents": {
"type": "integer"
},
"cpus": {
"type": "integer"
},
"errorEvents": {
"type": "integer"
},
"heapAlloc": {
"type": "integer"
},
"heapObjects": {
"type": "integer"
},
"latencyHistogram": {
"type": "array",
"items": {
"$ref": "#/definitions/kmsLatencyHistogram"
}
},
"requestActive": {
"type": "integer"
},
"requestErr": {
"type": "integer"
},
"requestFail": {
"type": "integer"
},
"requestOK": {
"type": "integer"
},
"stackAlloc": {
"type": "integer"
},
"threads": {
"type": "integer"
},
"uptime": {
"type": "integer"
},
"usableCPUs": {
"type": "integer"
}
}
},
"kmsStatusResponse": {
"type": "object",
"properties": {
"defaultKeyID": {
"type": "string"
},
"endpoints": {
"type": "array",
"items": {
"$ref": "#/definitions/kmsEndpoint"
}
},
"name": {
"type": "string"
}
}
},
"kmsVersionResponse": {
"type": "object",
"properties": {
"version": {
"type": "string"
}
}
},
"ldapEntities": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/definitions/ldapGroupPolicyEntity"
}
},
"policies": {
"type": "array",
"items": {
"$ref": "#/definitions/ldapPolicyEntity"
}
},
"timestamp": {
"type": "string"
},
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/ldapUserPolicyEntity"
}
}
}
},
"ldapEntitiesRequest": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"policies": {
"type": "array",
"items": {
"type": "string"
}
},
"users": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ldapGroupPolicyEntity": {
"type": "object",
"properties": {
"group": {
"type": "string"
},
"policies": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ldapPolicyEntity": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"policy": {
"type": "string"
},
"users": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ldapUserPolicyEntity": {
"type": "object",
"properties": {
"policies": {
"type": "array",
"items": {
"type": "string"
}
},
"user": {
"type": "string"
}
}
},
"license": {
"type": "object",
"properties": {
"account_id": {
"type": "integer"
},
"email": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"organization": {
"type": "string"
},
"plan": {
"type": "string"
},
"storage_capacity": {
"type": "integer"
}
}
},
"listAccessRulesResponse": {
"type": "object",
"properties": {
"accessRules": {
"type": "array",
"title": "list of policies",
"items": {
"$ref": "#/definitions/accessRule"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "total number of policies"
}
}
},
"listBucketEventsResponse": {
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/definitions/notificationConfig"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "total number of bucket events"
}
}
},
"listBucketsResponse": {
"type": "object",
"properties": {
"buckets": {
"type": "array",
"title": "list of resulting buckets",
"items": {
"$ref": "#/definitions/bucket"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "number of buckets accessible to the user"
}
}
},
"listConfigResponse": {
"type": "object",
"properties": {
"configurations": {
"type": "array",
"items": {
"$ref": "#/definitions/configDescription"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "total number of configurations"
}
}
},
"listExternalBucketsParams": {
"required": [
"accessKey",
"secretKey",
"targetURL",
"useTLS"
],
"properties": {
"accessKey": {
"type": "string",
"minLength": 3
},
"region": {
"type": "string"
},
"secretKey": {
"type": "string",
"minLength": 8
},
"targetURL": {
"type": "string"
},
"useTLS": {
"type": "boolean"
}
}
},
"listGroupsResponse": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"title": "list of groups",
"items": {
"type": "string"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "total number of groups"
}
}
},
"listObjectsResponse": {
"type": "object",
"properties": {
"objects": {
"type": "array",
"title": "list of resulting objects",
"items": {
"$ref": "#/definitions/bucketObject"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "number of objects"
}
}
},
"listPoliciesResponse": {
"type": "object",
"properties": {
"policies": {
"type": "array",
"title": "list of policies",
"items": {
"$ref": "#/definitions/policy"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "total number of policies"
}
}
},
"listRemoteBucketsResponse": {
"type": "object",
"properties": {
"buckets": {
"type": "array",
"title": "list of remote buckets",
"items": {
"$ref": "#/definitions/remoteBucket"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "number of remote buckets accessible to user"
}
}
},
"listUsersResponse": {
"type": "object",
"properties": {
"users": {
"type": "array",
"title": "list of resulting users",
"items": {
"$ref": "#/definitions/user"
}
}
}
},
"logSearchResponse": {
"type": "object",
"properties": {
"results": {
"type": "object",
"title": "list of log search responses"
}
}
},
"loginDetails": {
"type": "object",
"properties": {
"animatedLogin": {
"type": "boolean"
},
"isK8S": {
"type": "boolean"
},
"loginStrategy": {
"type": "string",
"enum": [
"form",
"redirect",
"service-account",
"redirect-service-account"
]
},
"redirectRules": {
"type": "array",
"items": {
"$ref": "#/definitions/redirectRule"
}
}
}
},
"loginOauth2AuthRequest": {
"type": "object",
"required": [
"state",
"code"
],
"properties": {
"code": {
"type": "string"
},
"state": {
"type": "string"
}
}
},
"loginRequest": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"features": {
"type": "object",
"properties": {
"hide_menu": {
"type": "boolean"
}
}
},
"secretKey": {
"type": "string"
},
"sts": {
"type": "string"
}
}
},
"loginResponse": {
"type": "object",
"properties": {
"IDPRefreshToken": {
"type": "string"
},
"sessionId": {
"type": "string"
}
}
},
"logoutRequest": {
"type": "object",
"properties": {
"state": {
"type": "string"
}
}
},
"makeBucketRequest": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
}
},
"makeBucketsResponse": {
"type": "object",
"properties": {
"bucketName": {
"type": "string"
}
}
},
"maxShareLinkExpResponse": {
"type": "object",
"required": [
"exp"
],
"properties": {
"exp": {
"type": "number",
"format": "int64"
}
}
},
"metadata": {
"type": "object",
"properties": {
"objectMetadata": {
"type": "object",
"additionalProperties": true
}
}
},
"multiBucketReplication": {
"required": [
"accessKey",
"secretKey",
"targetURL",
"bucketsRelation"
],
"properties": {
"accessKey": {
"type": "string",
"minLength": 3
},
"bandwidth": {
"type": "integer",
"format": "int64"
},
"bucketsRelation": {
"type": "array",
"minLength": 1,
"items": {
"$ref": "#/definitions/multiBucketsRelation"
}
},
"healthCheckPeriod": {
"type": "integer",
"format": "int32"
},
"prefix": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32",
"default": 0
},
"region": {
"type": "string"
},
"replicateDeleteMarkers": {
"type": "boolean"
},
"replicateDeletes": {
"type": "boolean"
},
"replicateExistingObjects": {
"type": "boolean"
},
"replicateMetadata": {
"type": "boolean"
},
"secretKey": {
"type": "string",
"minLength": 8
},
"storageClass": {
"type": "string",
"default": ""
},
"syncMode": {
"type": "string",
"default": "async",
"enum": [
"async",
"sync"
]
},
"tags": {
"type": "string"
},
"targetURL": {
"type": "string"
}
}
},
"multiBucketReplicationEdit": {
"properties": {
"arn": {
"type": "string"
},
"prefix": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32",
"default": 0
},
"replicateDeleteMarkers": {
"type": "boolean"
},
"replicateDeletes": {
"type": "boolean"
},
"replicateExistingObjects": {
"type": "boolean"
},
"replicateMetadata": {
"type": "boolean"
},
"ruleState": {
"type": "boolean"
},
"storageClass": {
"type": "string",
"default": ""
},
"tags": {
"type": "string",
"default": ""
}
}
},
"multiBucketResponseItem": {
"type": "object",
"properties": {
"errorString": {
"type": "string"
},
"originBucket": {
"type": "string"
},
"targetBucket": {
"type": "string"
}
}
},
"multiBucketResponseState": {
"type": "object",
"properties": {
"replicationState": {
"type": "array",
"items": {
"$ref": "#/definitions/multiBucketResponseItem"
}
}
}
},
"multiBucketsRelation": {
"type": "object",
"properties": {
"destinationBucket": {
"type": "string"
},
"originBucket": {
"type": "string"
}
}
},
"nofiticationService": {
"type": "string",
"enum": [
"webhook",
"amqp",
"kafka",
"mqtt",
"nats",
"nsq",
"mysql",
"postgres",
"elasticsearch",
"redis"
]
},
"notifEndpointResponse": {
"type": "object",
"properties": {
"notification_endpoints": {
"type": "array",
"items": {
"$ref": "#/definitions/notificationEndpointItem"
}
}
}
},
"notificationConfig": {
"type": "object",
"required": [
"arn"
],
"properties": {
"arn": {
"type": "string"
},
"events": {
"type": "array",
"title": "filter specific type of event. Defaults to all event (default: '[put,delete,get]')",
"items": {
"$ref": "#/definitions/notificationEventType"
}
},
"id": {
"type": "string"
},
"prefix": {
"type": "string",
"title": "filter event associated to the specified prefix"
},
"suffix": {
"type": "string",
"title": "filter event associated to the specified suffix"
}
}
},
"notificationDeleteRequest": {
"type": "object",
"required": [
"events",
"prefix",
"suffix"
],
"properties": {
"events": {
"type": "array",
"title": "filter specific type of event. Defaults to all event (default: '[put,delete,get]')",
"minLength": 1,
"items": {
"$ref": "#/definitions/notificationEventType"
}
},
"prefix": {
"type": "string",
"title": "filter event associated to the specified prefix"
},
"suffix": {
"type": "string",
"title": "filter event associated to the specified suffix"
}
}
},
"notificationEndpoint": {
"type": "object",
"required": [
"service",
"account_id",
"properties"
],
"properties": {
"account_id": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"service": {
"$ref": "#/definitions/nofiticationService"
}
}
},
"notificationEndpointItem": {
"type": "object",
"properties": {
"account_id": {
"type": "string"
},
"service": {
"$ref": "#/definitions/nofiticationService"
},
"status": {
"type": "string"
}
}
},
"notificationEventType": {
"type": "string",
"enum": [
"put",
"delete",
"get",
"replica",
"ilm",
"scanner"
]
},
"objectLegalHoldStatus": {
"type": "string",
"enum": [
"enabled",
"disabled"
]
},
"objectRetentionMode": {
"type": "string",
"enum": [
"governance",
"compliance"
]
},
"objectRetentionUnit": {
"type": "string",
"enum": [
"days",
"years"
]
},
"peerInfo": {
"type": "object",
"properties": {
"deploymentID": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"peerInfoRemove": {
"type": "object",
"required": [
"sites"
],
"properties": {
"all": {
"type": "boolean"
},
"sites": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"peerSite": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"name": {
"type": "string"
},
"secretKey": {
"type": "string"
}
}
},
"peerSiteEditResponse": {
"type": "object",
"properties": {
"errorDetail": {
"type": "string"
},
"status": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"peerSiteRemoveResponse": {
"type": "object",
"properties": {
"errorDetail": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"permissionResource": {
"type": "object",
"properties": {
"conditionOperator": {
"type": "string"
},
"prefixes": {
"type": "array",
"items": {
"type": "string"
}
},
"resource": {
"type": "string"
}
}
},
"policy": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"policy": {
"type": "string"
}
}
},
"policyArgs": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"bucket_name": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"policyEntity": {
"type": "string",
"default": "user",
"enum": [
"user",
"group"
]
},
"prefixAccessPair": {
"type": "object",
"properties": {
"access": {
"type": "string"
},
"prefix": {
"type": "string"
}
}
},
"prefixWrapper": {
"type": "object",
"properties": {
"prefix": {
"type": "string"
}
}
},
"principal": {
"type": "object",
"properties": {
"STSAccessKeyID": {
"type": "string"
},
"STSSecretAccessKey": {
"type": "string"
},
"STSSessionToken": {
"type": "string"
},
"accountAccessKey": {
"type": "string"
},
"customStyleOb": {
"type": "string"
},
"hm": {
"type": "boolean"
},
"ob": {
"type": "boolean"
}
}
},
"profilingStartRequest": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
}
}
},
"putBucketRetentionRequest": {
"type": "object",
"required": [
"mode",
"unit",
"validity"
],
"properties": {
"mode": {
"$ref": "#/definitions/objectRetentionMode"
},
"unit": {
"$ref": "#/definitions/objectRetentionUnit"
},
"validity": {
"type": "integer",
"format": "int32"
}
}
},
"putBucketTagsRequest": {
"type": "object",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
}
}
}
},
"putObjectLegalHoldRequest": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"$ref": "#/definitions/objectLegalHoldStatus"
}
}
},
"putObjectRetentionRequest": {
"type": "object",
"required": [
"mode",
"expires"
],
"properties": {
"expires": {
"type": "string"
},
"governance_bypass": {
"type": "boolean"
},
"mode": {
"$ref": "#/definitions/objectRetentionMode"
}
}
},
"putObjectTagsRequest": {
"type": "object",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
}
}
}
},
"redirectRule": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"redirect": {
"type": "string"
},
"serviceType": {
"type": "string"
}
}
},
"releaseAuthor": {
"type": "object",
"properties": {
"avatar_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"receivedEvents_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"releaseInfo": {
"type": "object",
"properties": {
"breakingChangesContent": {
"type": "string"
},
"contextContent": {
"type": "string"
},
"metadata": {
"$ref": "#/definitions/releaseMetadata"
},
"newFeaturesContent": {
"type": "string"
},
"notesContent": {
"type": "string"
},
"securityContent": {
"type": "string"
}
}
},
"releaseListResponse": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/releaseInfo"
}
}
}
},
"releaseMetadata": {
"type": "object",
"properties": {
"assets_url": {
"type": "string"
},
"author": {
"$ref": "#/definitions/releaseAuthor"
},
"created_at": {
"type": "string"
},
"draft": {
"type": "boolean"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"prerelease": {
"type": "boolean"
},
"published_at": {
"type": "string"
},
"tag_name": {
"type": "string"
},
"tarball_url": {
"type": "string"
},
"target_commitish": {
"type": "string"
},
"upload_url": {
"type": "string"
},
"url": {
"type": "string"
},
"zipball_url": {
"type": "string"
}
}
},
"remoteBucket": {
"type": "object",
"required": [
"accessKey",
"sourceBucket",
"remoteARN"
],
"properties": {
"accessKey": {
"type": "string",
"minLength": 3
},
"bandwidth": {
"type": "integer",
"format": "int64"
},
"healthCheckPeriod": {
"type": "integer"
},
"remoteARN": {
"type": "string"
},
"secretKey": {
"type": "string",
"minLength": 8
},
"service": {
"type": "string",
"enum": [
"replication"
]
},
"sourceBucket": {
"type": "string"
},
"status": {
"type": "string"
},
"syncMode": {
"type": "string"
},
"targetBucket": {
"type": "string"
},
"targetURL": {
"type": "string"
}
}
},
"resultTarget": {
"type": "object",
"properties": {
"legendFormat": {
"type": "string"
},
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/widgetResult"
}
},
"resultType": {
"type": "string"
}
}
},
"rewindItem": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"delete_flag": {
"type": "boolean"
},
"is_latest": {
"type": "boolean"
},
"last_modified": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
},
"version_id": {
"type": "string"
}
}
},
"rewindResponse": {
"type": "object",
"properties": {
"objects": {
"type": "array",
"items": {
"$ref": "#/definitions/rewindItem"
}
}
}
},
"selectedSAs": {
"type": "array",
"items": {
"type": "string"
}
},
"selectedUsers": {
"type": "array",
"items": {
"type": "string"
}
},
"serverDrives": {
"type": "object",
"properties": {
"availableSpace": {
"type": "integer"
},
"drivePath": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"healing": {
"type": "boolean"
},
"model": {
"type": "string"
},
"rootDisk": {
"type": "boolean"
},
"state": {
"type": "string"
},
"totalSpace": {
"type": "integer"
},
"usedSpace": {
"type": "integer"
},
"uuid": {
"type": "string"
}
}
},
"serverProperties": {
"type": "object",
"properties": {
"commitID": {
"type": "string"
},
"drives": {
"type": "array",
"items": {
"$ref": "#/definitions/serverDrives"
}
},
"endpoint": {
"type": "string"
},
"network": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"poolNumber": {
"type": "integer"
},
"state": {
"type": "string"
},
"uptime": {
"type": "integer"
},
"version": {
"type": "string"
}
}
},
"serviceAccount": {
"type": "object",
"properties": {
"accountStatus": {
"type": "string"
},
"description": {
"type": "string"
},
"expiration": {
"type": "string"
},
"impliedPolicy": {
"type": "boolean"
},
"name": {
"type": "string"
},
"parentUser": {
"type": "string"
},
"policy": {
"type": "string"
}
}
},
"serviceAccountCreds": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"serviceAccountRequest": {
"type": "object",
"properties": {
"comment": {
"type": "string"
},
"description": {
"type": "string"
},
"expiry": {
"type": "string"
},
"name": {
"type": "string"
},
"policy": {
"type": "string",
"title": "policy to be applied to the Service Account if any"
}
}
},
"serviceAccountRequestCreds": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"comment": {
"type": "string"
},
"description": {
"type": "string"
},
"expiry": {
"type": "string"
},
"name": {
"type": "string"
},
"policy": {
"type": "string",
"title": "policy to be applied to the Service Account if any"
},
"secretKey": {
"type": "string"
}
}
},
"serviceAccounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"accountStatus": {
"type": "string"
},
"description": {
"type": "string"
},
"expiration": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"sessionResponse": {
"type": "object",
"properties": {
"allowResources": {
"type": "array",
"items": {
"$ref": "#/definitions/permissionResource"
}
},
"customStyles": {
"type": "string"
},
"distributedMode": {
"type": "boolean"
},
"envConstants": {
"$ref": "#/definitions/environmentConstants"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"operator": {
"type": "boolean"
},
"permissions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"serverEndPoint": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ok"
]
}
}
},
"setBucketPolicyRequest": {
"type": "object",
"required": [
"access"
],
"properties": {
"access": {
"$ref": "#/definitions/bucketAccess"
},
"definition": {
"type": "string"
}
}
},
"setBucketQuota": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"amount": {
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"quota_type": {
"type": "string",
"enum": [
"hard"
]
}
}
},
"setBucketVersioning": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"excludeFolders": {
"type": "boolean"
},
"excludePrefixes": {
"type": "array",
"maxLength": 10,
"items": {
"type": "string"
}
}
}
},
"setConfigRequest": {
"type": "object",
"required": [
"key_values"
],
"properties": {
"arn_resource_id": {
"type": "string",
"title": "Used if configuration is an event notification's target"
},
"key_values": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/configurationKV"
}
}
}
},
"setConfigResponse": {
"type": "object",
"properties": {
"restart": {
"description": "Returns wheter server needs to restart to apply changes or not",
"type": "boolean"
}
}
},
"setIDPResponse": {
"type": "object",
"properties": {
"restart": {
"type": "boolean"
}
}
},
"setNotificationEndpointResponse": {
"type": "object",
"required": [
"service",
"account_id",
"properties"
],
"properties": {
"account_id": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"restart": {
"type": "boolean"
},
"service": {
"$ref": "#/definitions/nofiticationService"
}
}
},
"setPolicyMultipleNameRequest": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/definitions/iamEntity"
}
},
"name": {
"type": "array",
"items": {
"type": "string"
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/iamEntity"
}
}
}
},
"setPolicyNameRequest": {
"type": "object",
"required": [
"name",
"entityType",
"entityName"
],
"properties": {
"entityName": {
"type": "string"
},
"entityType": {
"$ref": "#/definitions/policyEntity"
},
"name": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"setPolicyRequest": {
"type": "object",
"required": [
"entityType",
"entityName"
],
"properties": {
"entityName": {
"type": "string"
},
"entityType": {
"$ref": "#/definitions/policyEntity"
}
}
},
"siteReplicationAddRequest": {
"type": "array",
"items": {
"$ref": "#/definitions/peerSite"
}
},
"siteReplicationAddResponse": {
"type": "object",
"properties": {
"errorDetail": {
"type": "string"
},
"initialSyncErrorMessage": {
"type": "string"
},
"status": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"siteReplicationInfoResponse": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"serviceAccountAccessKey": {
"type": "string"
},
"sites": {
"type": "array",
"items": {
"$ref": "#/definitions/peerInfo"
}
}
}
},
"siteReplicationStatusResponse": {
"type": "object",
"properties": {
"bucketStats": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"groupStats": {
"type": "object"
},
"maxBuckets": {
"type": "integer"
},
"maxGroups": {
"type": "integer"
},
"maxPolicies": {
"type": "integer"
},
"maxUsers": {
"type": "integer"
},
"policyStats": {
"type": "object"
},
"sites": {
"type": "object"
},
"statsSummary": {
"type": "object"
},
"userStats": {
"type": "object"
}
}
},
"startProfilingItem": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"nodeName": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"startProfilingList": {
"type": "object",
"properties": {
"startResults": {
"type": "array",
"items": {
"$ref": "#/definitions/startProfilingItem"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "number of start results"
}
}
},
"updateGroupRequest": {
"type": "object",
"required": [
"members",
"status"
],
"properties": {
"members": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
}
}
},
"updateServiceAccountRequest": {
"type": "object",
"required": [
"policy"
],
"properties": {
"description": {
"type": "string"
},
"expiry": {
"type": "string"
},
"name": {
"type": "string"
},
"policy": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"updateUser": {
"type": "object",
"required": [
"status",
"groups"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
}
}
},
"updateUserGroups": {
"type": "object",
"required": [
"groups"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"user": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"hasPolicy": {
"type": "boolean"
},
"memberOf": {
"type": "array",
"items": {
"type": "string"
}
},
"policy": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
}
}
},
"userSAs": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"recursive": {
"type": "boolean"
},
"versionID": {
"type": "string"
}
}
},
"userServiceAccountItem": {
"type": "object",
"properties": {
"numSAs": {
"type": "integer",
"format": "int64"
},
"userName": {
"type": "string"
}
}
},
"userServiceAccountSummary": {
"type": "object",
"properties": {
"hasSA": {
"type": "boolean"
},
"userServiceAccountList": {
"type": "array",
"title": "list of users with number of service accounts",
"items": {
"$ref": "#/definitions/userServiceAccountItem"
}
}
}
},
"widget": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"options": {
"type": "object",
"properties": {
"reduceOptions": {
"type": "object",
"properties": {
"calcs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"targets": {
"type": "array",
"items": {
"$ref": "#/definitions/resultTarget"
}
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"widgetDetails": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"options": {
"type": "object",
"properties": {
"reduceOptions": {
"type": "object",
"properties": {
"calcs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"targets": {
"type": "array",
"items": {
"$ref": "#/definitions/resultTarget"
}
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"widgetResult": {
"type": "object",
"properties": {
"metric": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"values": {
"type": "array",
"items": {}
}
}
}
},
"parameters": {
"limit": {
"type": "number",
"format": "int32",
"default": 20,
"name": "limit",
"in": "query"
},
"offset": {
"type": "number",
"format": "int32",
"default": 0,
"name": "offset",
"in": "query"
}
},
"securityDefinitions": {
"anonymous": {
"type": "apiKey",
"name": "X-Anonymous",
"in": "header"
},
"key": {
"type": "oauth2",
"flow": "accessCode",
"authorizationUrl": "http://min.io",
"tokenUrl": "http://min.io"
}
},
"security": [
{
"key": []
}
]
}`))
FlatSwaggerJSON = json.RawMessage([]byte(`{
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"http",
"ws"
],
"swagger": "2.0",
"info": {
"title": "MinIO Console Server",
"version": "0.1.0"
},
"basePath": "/api/v1",
"paths": {
"/admin/info": {
"get": {
"tags": [
"System"
],
"summary": "Returns information about the deployment",
"operationId": "AdminInfo",
"parameters": [
{
"type": "boolean",
"default": false,
"name": "defaultOnly",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/adminInfoResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets": {
"get": {
"tags": [
"Bucket"
],
"summary": "List Buckets",
"operationId": "ListBuckets",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/listBucketsResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
},
"post": {
"tags": [
"Bucket"
],
"summary": "Make bucket",
"operationId": "MakeBucket",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/makeBucketRequest"
}
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/makeBucketsResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/max-share-exp": {
"get": {
"tags": [
"Bucket"
],
"summary": "Get max expiration time for share link in seconds",
"operationId": "GetMaxShareLinkExp",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/maxShareLinkExpResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/delete-objects": {
"post": {
"tags": [
"Object"
],
"summary": "Delete Multiple Objects",
"operationId": "DeleteMultipleObjects",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "boolean",
"name": "all_versions",
"in": "query"
},
{
"type": "boolean",
"name": "bypass",
"in": "query"
},
{
"name": "files",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/deleteFile"
}
}
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects": {
"get": {
"security": [
{
"key": []
},
{
"anonymous": []
}
],
"tags": [
"Object"
],
"summary": "List Objects",
"operationId": "ListObjects",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query"
},
{
"type": "boolean",
"name": "recursive",
"in": "query"
},
{
"type": "boolean",
"name": "with_versions",
"in": "query"
},
{
"type": "boolean",
"name": "with_metadata",
"in": "query"
},
{
"type": "number",
"format": "int32",
"default": 20,
"name": "limit",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/listObjectsResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
},
"delete": {
"tags": [
"Object"
],
"summary": "Delete Object",
"operationId": "DeleteObject",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query",
"required": true
},
{
"type": "string",
"name": "version_id",
"in": "query"
},
{
"type": "boolean",
"name": "recursive",
"in": "query"
},
{
"type": "boolean",
"name": "all_versions",
"in": "query"
},
{
"type": "boolean",
"name": "non_current_versions",
"in": "query"
},
{
"type": "boolean",
"name": "bypass",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/download": {
"get": {
"security": [
{
"key": []
},
{
"anonymous": []
}
],
"produces": [
"application/octet-stream"
],
"tags": [
"Object"
],
"summary": "Download Object",
"operationId": "Download Object",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query",
"required": true
},
{
"type": "string",
"name": "version_id",
"in": "query"
},
{
"type": "boolean",
"default": false,
"name": "preview",
"in": "query"
},
{
"type": "string",
"default": "",
"name": "override_file_name",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"type": "file"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/download-multiple": {
"post": {
"security": [
{
"key": []
},
{
"anonymous": []
}
],
"produces": [
"application/octet-stream"
],
"tags": [
"Object"
],
"summary": "Download Multiple Objects",
"operationId": "DownloadMultipleObjects",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"name": "objectList",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"type": "file"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/metadata": {
"get": {
"tags": [
"Object"
],
"summary": "Gets the metadata of an object",
"operationId": "GetObjectMetadata",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query",
"required": true
},
{
"type": "string",
"name": "versionID",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/metadata"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/restore": {
"put": {
"tags": [
"Object"
],
"summary": "Restore Object to a selected version",
"operationId": "PutObjectRestore",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query",
"required": true
},
{
"type": "string",
"name": "version_id",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/share": {
"get": {
"tags": [
"Object"
],
"summary": "Shares an Object on a url",
"operationId": "ShareObject",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query",
"required": true
},
{
"type": "string",
"name": "version_id",
"in": "query",
"required": true
},
{
"type": "string",
"name": "expires",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"type": "string"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/tags": {
"put": {
"tags": [
"Object"
],
"summary": "Put Object's tags",
"operationId": "PutObjectTags",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query",
"required": true
},
{
"type": "string",
"name": "version_id",
"in": "query",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/putObjectTagsRequest"
}
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/objects/upload": {
"post": {
"security": [
{
"key": []
},
{
"anonymous": []
}
],
"consumes": [
"multipart/form-data"
],
"tags": [
"Object"
],
"summary": "Uploads an Object.",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/rewind/{date}": {
"get": {
"tags": [
"Bucket"
],
"summary": "Get objects in a bucket for a rewind date",
"operationId": "GetBucketRewind",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"type": "string",
"name": "date",
"in": "path",
"required": true
},
{
"type": "string",
"name": "prefix",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/rewindResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/tags": {
"put": {
"tags": [
"Bucket"
],
"summary": "Put Bucket's tags",
"operationId": "PutBucketTags",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/putBucketTagsRequest"
}
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{bucket_name}/versioning": {
"get": {
"tags": [
"Bucket"
],
"summary": "Bucket Versioning",
"operationId": "GetBucketVersioning",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/bucketVersioningResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
},
"put": {
"tags": [
"Bucket"
],
"summary": "Set Bucket Versioning",
"operationId": "SetBucketVersioning",
"parameters": [
{
"type": "string",
"name": "bucket_name",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/setBucketVersioning"
}
}
],
"responses": {
"201": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{name}": {
"get": {
"tags": [
"Bucket"
],
"summary": "Bucket Info",
"operationId": "BucketInfo",
"parameters": [
{
"type": "string",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/bucket"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/buckets/{name}/quota": {
"get": {
"tags": [
"Bucket"
],
"summary": "Get Bucket Quota",
"operationId": "GetBucketQuota",
"parameters": [
{
"type": "string",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/bucketQuota"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/download-shared-object/{url}": {
"get": {
"security": [],
"produces": [
"application/octet-stream"
],
"tags": [
"Public"
],
"summary": "Downloads an object from a presigned url",
"operationId": "DownloadSharedObject",
"parameters": [
{
"type": "string",
"name": "url",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"type": "file"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/license/acknowledge": {
"get": {
"tags": [
"License"
],
"summary": "Acknowledge the license",
"operationId": "LicenseAcknowledge",
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/login": {
"get": {
"security": [],
"tags": [
"Auth"
],
"summary": "Returns login strategy, form or sso.",
"operationId": "LoginDetail",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/loginDetails"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
},
"post": {
"security": [],
"tags": [
"Auth"
],
"summary": "Login to Console",
"operationId": "Login",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/loginRequest"
}
}
],
"responses": {
"204": {
"description": "A successful login."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/login/oauth2/auth": {
"post": {
"security": [],
"tags": [
"Auth"
],
"summary": "Identity Provider oauth2 callback endpoint.",
"operationId": "LoginOauth2Auth",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/loginOauth2AuthRequest"
}
}
],
"responses": {
"204": {
"description": "A successful login."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/logout": {
"post": {
"tags": [
"Auth"
],
"summary": "Logout from Console.",
"operationId": "Logout",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/logoutRequest"
}
}
],
"responses": {
"200": {
"description": "A successful response."
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/session": {
"get": {
"tags": [
"Auth"
],
"summary": "Endpoint to check if your session is still valid",
"operationId": "SessionCheck",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/sessionResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
},
"/users": {
"get": {
"tags": [
"User"
],
"summary": "List Users",
"operationId": "ListUsers",
"parameters": [
{
"type": "number",
"format": "int32",
"default": 0,
"name": "offset",
"in": "query"
},
{
"type": "number",
"format": "int32",
"default": 20,
"name": "limit",
"in": "query"
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/listUsersResponse"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
}
}
}
},
"definitions": {
"ApiError": {
"type": "object",
"properties": {
"detailedMessage": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"BackendProperties": {
"type": "object",
"properties": {
"backendType": {
"type": "string"
},
"offlineDrives": {
"type": "integer"
},
"onlineDrives": {
"type": "integer"
},
"rrSCParity": {
"type": "integer"
},
"standardSCParity": {
"type": "integer"
}
}
},
"BucketDetails": {
"type": "object",
"properties": {
"locking": {
"type": "boolean"
},
"quota": {
"type": "object",
"properties": {
"quota": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string",
"enum": [
"hard"
]
}
}
},
"replication": {
"type": "boolean"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"versioning": {
"type": "boolean"
},
"versioningSuspended": {
"type": "boolean"
}
}
},
"BucketDetailsQuota": {
"type": "object",
"properties": {
"quota": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string",
"enum": [
"hard"
]
}
}
},
"BucketRwAccess": {
"type": "object",
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
}
},
"BucketVersioningResponseExcludedPrefixesItems0": {
"type": "object",
"properties": {
"prefix": {
"type": "string"
}
}
},
"LoginRequestFeatures": {
"type": "object",
"properties": {
"hide_menu": {
"type": "boolean"
}
}
},
"ServiceAccountsItems0": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"accountStatus": {
"type": "string"
},
"description": {
"type": "string"
},
"expiration": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"WidgetDetailsOptions": {
"type": "object",
"properties": {
"reduceOptions": {
"type": "object",
"properties": {
"calcs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"WidgetDetailsOptionsReduceOptions": {
"type": "object",
"properties": {
"calcs": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"WidgetOptions": {
"type": "object",
"properties": {
"reduceOptions": {
"type": "object",
"properties": {
"calcs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"WidgetOptionsReduceOptions": {
"type": "object",
"properties": {
"calcs": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"aUserPolicyResponse": {
"type": "object",
"properties": {
"policy": {
"type": "string"
}
}
},
"accessRule": {
"type": "object",
"properties": {
"access": {
"type": "string"
},
"prefix": {
"type": "string"
}
}
},
"accountChangePasswordRequest": {
"type": "object",
"required": [
"current_secret_key",
"new_secret_key"
],
"properties": {
"current_secret_key": {
"type": "string"
},
"new_secret_key": {
"type": "string"
}
}
},
"addBucketReplication": {
"type": "object",
"properties": {
"arn": {
"type": "string"
},
"destination_bucket": {
"type": "string"
}
}
},
"addGroupRequest": {
"type": "object",
"required": [
"group",
"members"
],
"properties": {
"group": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"addPolicyRequest": {
"type": "object",
"required": [
"name",
"policy"
],
"properties": {
"name": {
"type": "string"
},
"policy": {
"type": "string"
}
}
},
"addUserRequest": {
"type": "object",
"required": [
"accessKey",
"secretKey",
"groups",
"policies"
],
"properties": {
"accessKey": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"policies": {
"type": "array",
"items": {
"type": "string"
}
},
"secretKey": {
"type": "string"
}
}
},
"adminInfoResponse": {
"type": "object",
"properties": {
"advancedMetricsStatus": {
"type": "string",
"enum": [
"not configured",
"available",
"unavailable"
]
},
"backend": {
"$ref": "#/definitions/BackendProperties"
},
"buckets": {
"type": "integer"
},
"objects": {
"type": "integer"
},
"servers": {
"type": "array",
"items": {
"$ref": "#/definitions/serverProperties"
}
},
"usage": {
"type": "integer"
},
"widgets": {
"type": "array",
"items": {
"$ref": "#/definitions/widget"
}
}
}
},
"apiKey": {
"type": "object",
"properties": {
"apiKey": {
"type": "string"
}
}
},
"arnsResponse": {
"type": "object",
"properties": {
"arns": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"bucket": {
"type": "object",
"required": [
"name"
],
"properties": {
"access": {
"$ref": "#/definitions/bucketAccess"
},
"creation_date": {
"type": "string"
},
"definition": {
"type": "string"
},
"details": {
"type": "object",
"properties": {
"locking": {
"type": "boolean"
},
"quota": {
"type": "object",
"properties": {
"quota": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string",
"enum": [
"hard"
]
}
}
},
"replication": {
"type": "boolean"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"versioning": {
"type": "boolean"
},
"versioningSuspended": {
"type": "boolean"
}
}
},
"name": {
"type": "string",
"minLength": 3
},
"objects": {
"type": "integer",
"format": "int64"
},
"rw_access": {
"type": "object",
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
}
},
"size": {
"type": "integer",
"format": "int64"
}
}
},
"bucketAccess": {
"type": "string",
"default": "PRIVATE",
"enum": [
"PRIVATE",
"PUBLIC",
"CUSTOM"
]
},
"bucketEncryptionInfo": {
"type": "object",
"properties": {
"algorithm": {
"type": "string"
},
"kmsMasterKeyID": {
"type": "string"
}
}
},
"bucketEncryptionRequest": {
"type": "object",
"properties": {
"encType": {
"$ref": "#/definitions/bucketEncryptionType"
},
"kmsKeyID": {
"type": "string"
}
}
},
"bucketEncryptionType": {
"type": "string",
"default": "sse-s3",
"enum": [
"sse-s3",
"sse-kms"
]
},
"bucketEventRequest": {
"type": "object",
"required": [
"configuration"
],
"properties": {
"configuration": {
"$ref": "#/definitions/notificationConfig"
},
"ignoreExisting": {
"type": "boolean"
}
}
},
"bucketObLockingResponse": {
"type": "object",
"properties": {
"object_locking_enabled": {
"type": "boolean"
}
}
},
"bucketObject": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"etag": {
"type": "string"
},
"expiration": {
"type": "string"
},
"expiration_rule_id": {
"type": "string"
},
"is_delete_marker": {
"type": "boolean"
},
"is_latest": {
"type": "boolean"
},
"last_modified": {
"type": "string"
},
"legal_hold_status": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"retention_mode": {
"type": "string"
},
"retention_until_date": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"user_metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"user_tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"version_id": {
"type": "string"
}
}
},
"bucketQuota": {
"type": "object",
"properties": {
"quota": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"hard"
]
}
}
},
"bucketReplicationDestination": {
"type": "object",
"properties": {
"bucket": {
"type": "string"
}
}
},
"bucketReplicationResponse": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/bucketReplicationRule"
}
}
}
},
"bucketReplicationRule": {
"type": "object",
"properties": {
"bandwidth": {
"type": "string"
},
"delete_marker_replication": {
"type": "boolean"
},
"deletes_replication": {
"type": "boolean"
},
"destination": {
"$ref": "#/definitions/bucketReplicationDestination"
},
"existingObjects": {
"type": "boolean"
},
"healthCheckPeriod": {
"type": "integer"
},
"id": {
"type": "string"
},
"metadata_replication": {
"type": "boolean"
},
"prefix": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"storageClass": {
"type": "string"
},
"syncMode": {
"type": "string",
"default": "async",
"enum": [
"async",
"sync"
]
},
"tags": {
"type": "string"
}
}
},
"bucketReplicationRuleList": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"bucketVersioningResponse": {
"type": "object",
"properties": {
"MFADelete": {
"type": "string"
},
"excludeFolders": {
"type": "boolean"
},
"excludedPrefixes": {
"type": "array",
"items": {
"$ref": "#/definitions/BucketVersioningResponseExcludedPrefixesItems0"
}
},
"status": {
"type": "string"
}
}
},
"bulkUserGroups": {
"type": "object",
"required": [
"users",
"groups"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"users": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"callHomeGetResponse": {
"type": "object",
"properties": {
"diagnosticsStatus": {
"type": "boolean"
},
"logsStatus": {
"type": "boolean"
}
}
},
"callHomeSetStatus": {
"type": "object",
"required": [
"diagState",
"logsState"
],
"properties": {
"diagState": {
"type": "boolean"
},
"logsState": {
"type": "boolean"
}
}
},
"changeUserPasswordRequest": {
"type": "object",
"required": [
"selectedUser",
"newSecretKey"
],
"properties": {
"newSecretKey": {
"type": "string"
},
"selectedUser": {
"type": "string"
}
}
},
"configDescription": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"key": {
"type": "string"
}
}
},
"configExportResponse": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"value": {
"description": "Returns base64 encoded value",
"type": "string"
}
}
},
"configuration": {
"type": "object",
"properties": {
"key_values": {
"type": "array",
"items": {
"$ref": "#/definitions/configurationKV"
}
},
"name": {
"type": "string"
}
}
},
"configurationKV": {
"type": "object",
"properties": {
"env_override": {
"$ref": "#/definitions/envOverride"
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"createRemoteBucket": {
"required": [
"accessKey",
"secretKey",
"targetURL",
"sourceBucket",
"targetBucket"
],
"properties": {
"accessKey": {
"type": "string",
"minLength": 3
},
"bandwidth": {
"type": "integer",
"format": "int64"
},
"healthCheckPeriod": {
"type": "integer",
"format": "int32"
},
"region": {
"type": "string"
},
"secretKey": {
"type": "string",
"minLength": 8
},
"sourceBucket": {
"type": "string"
},
"syncMode": {
"type": "string",
"default": "async",
"enum": [
"async",
"sync"
]
},
"targetBucket": {
"type": "string"
},
"targetURL": {
"type": "string"
}
}
},
"deleteFile": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"recursive": {
"type": "boolean"
},
"versionID": {
"type": "string"
}
}
},
"envOverride": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"environmentConstants": {
"type": "object",
"properties": {
"maxConcurrentDownloads": {
"type": "integer"
},
"maxConcurrentUploads": {
"type": "integer"
}
}
},
"getBucketRetentionConfig": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/definitions/objectRetentionMode"
},
"unit": {
"$ref": "#/definitions/objectRetentionUnit"
},
"validity": {
"type": "integer",
"format": "int32"
}
}
},
"group": {
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"policy": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"iamEntity": {
"type": "string"
},
"iamPolicy": {
"type": "object",
"properties": {
"statement": {
"type": "array",
"items": {
"$ref": "#/definitions/iamPolicyStatement"
}
},
"version": {
"type": "string"
}
}
},
"iamPolicyStatement": {
"type": "object",
"properties": {
"action": {
"type": "array",
"items": {
"type": "string"
}
},
"condition": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"effect": {
"type": "string"
},
"resource": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"idpListConfigurationsResponse": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/idpServerConfiguration"
}
}
}
},
"idpServerConfiguration": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"info": {
"type": "array",
"items": {
"$ref": "#/definitions/idpServerConfigurationInfo"
}
},
"input": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"idpServerConfigurationInfo": {
"type": "object",
"properties": {
"isCfg": {
"type": "boolean"
},
"isEnv": {
"type": "boolean"
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"kmsAPI": {
"type": "object",
"properties": {
"maxBody": {
"type": "integer"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"timeout": {
"type": "integer"
}
}
},
"kmsAPIsResponse": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/kmsAPI"
}
}
}
},
"kmsCreateKeyRequest": {
"type": "object",
"required": [
"key"
],
"properties": {
"key": {
"type": "string"
}
}
},
"kmsEndpoint": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"kmsKeyInfo": {
"type": "object",
"properties": {
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"kmsKeyStatusResponse": {
"type": "object",
"properties": {
"decryptionErr": {
"type": "string"
},
"encryptionErr": {
"type": "string"
},
"keyID": {
"type": "string"
}
}
},
"kmsLatencyHistogram": {
"type": "object",
"properties": {
"duration": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"kmsListKeysResponse": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/kmsKeyInfo"
}
}
}
},
"kmsMetricsResponse": {
"type": "object",
"required": [
"requestOK",
"requestErr",
"requestFail",
"requestActive",
"auditEvents",
"errorEvents",
"latencyHistogram",
"uptime",
"cpus",
"usableCPUs",
"threads",
"heapAlloc",
"stackAlloc"
],
"properties": {
"auditEvents": {
"type": "integer"
},
"cpus": {
"type": "integer"
},
"errorEvents": {
"type": "integer"
},
"heapAlloc": {
"type": "integer"
},
"heapObjects": {
"type": "integer"
},
"latencyHistogram": {
"type": "array",
"items": {
"$ref": "#/definitions/kmsLatencyHistogram"
}
},
"requestActive": {
"type": "integer"
},
"requestErr": {
"type": "integer"
},
"requestFail": {
"type": "integer"
},
"requestOK": {
"type": "integer"
},
"stackAlloc": {
"type": "integer"
},
"threads": {
"type": "integer"
},
"uptime": {
"type": "integer"
},
"usableCPUs": {
"type": "integer"
}
}
},
"kmsStatusResponse": {
"type": "object",
"properties": {
"defaultKeyID": {
"type": "string"
},
"endpoints": {
"type": "array",
"items": {
"$ref": "#/definitions/kmsEndpoint"
}
},
"name": {
"type": "string"
}
}
},
"kmsVersionResponse": {
"type": "object",
"properties": {
"version": {
"type": "string"
}
}
},
"ldapEntities": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/definitions/ldapGroupPolicyEntity"
}
},
"policies": {
"type": "array",
"items": {
"$ref": "#/definitions/ldapPolicyEntity"
}
},
"timestamp": {
"type": "string"
},
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/ldapUserPolicyEntity"
}
}
}
},
"ldapEntitiesRequest": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"policies": {
"type": "array",
"items": {
"type": "string"
}
},
"users": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ldapGroupPolicyEntity": {
"type": "object",
"properties": {
"group": {
"type": "string"
},
"policies": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ldapPolicyEntity": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"policy": {
"type": "string"
},
"users": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ldapUserPolicyEntity": {
"type": "object",
"properties": {
"policies": {
"type": "array",
"items": {
"type": "string"
}
},
"user": {
"type": "string"
}
}
},
"license": {
"type": "object",
"properties": {
"account_id": {
"type": "integer"
},
"email": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"organization": {
"type": "string"
},
"plan": {
"type": "string"
},
"storage_capacity": {
"type": "integer"
}
}
},
"listAccessRulesResponse": {
"type": "object",
"properties": {
"accessRules": {
"type": "array",
"title": "list of policies",
"items": {
"$ref": "#/definitions/accessRule"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "total number of policies"
}
}
},
"listBucketEventsResponse": {
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/definitions/notificationConfig"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "total number of bucket events"
}
}
},
"listBucketsResponse": {
"type": "object",
"properties": {
"buckets": {
"type": "array",
"title": "list of resulting buckets",
"items": {
"$ref": "#/definitions/bucket"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "number of buckets accessible to the user"
}
}
},
"listConfigResponse": {
"type": "object",
"properties": {
"configurations": {
"type": "array",
"items": {
"$ref": "#/definitions/configDescription"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "total number of configurations"
}
}
},
"listExternalBucketsParams": {
"required": [
"accessKey",
"secretKey",
"targetURL",
"useTLS"
],
"properties": {
"accessKey": {
"type": "string",
"minLength": 3
},
"region": {
"type": "string"
},
"secretKey": {
"type": "string",
"minLength": 8
},
"targetURL": {
"type": "string"
},
"useTLS": {
"type": "boolean"
}
}
},
"listGroupsResponse": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"title": "list of groups",
"items": {
"type": "string"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "total number of groups"
}
}
},
"listObjectsResponse": {
"type": "object",
"properties": {
"objects": {
"type": "array",
"title": "list of resulting objects",
"items": {
"$ref": "#/definitions/bucketObject"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "number of objects"
}
}
},
"listPoliciesResponse": {
"type": "object",
"properties": {
"policies": {
"type": "array",
"title": "list of policies",
"items": {
"$ref": "#/definitions/policy"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "total number of policies"
}
}
},
"listRemoteBucketsResponse": {
"type": "object",
"properties": {
"buckets": {
"type": "array",
"title": "list of remote buckets",
"items": {
"$ref": "#/definitions/remoteBucket"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "number of remote buckets accessible to user"
}
}
},
"listUsersResponse": {
"type": "object",
"properties": {
"users": {
"type": "array",
"title": "list of resulting users",
"items": {
"$ref": "#/definitions/user"
}
}
}
},
"logSearchResponse": {
"type": "object",
"properties": {
"results": {
"type": "object",
"title": "list of log search responses"
}
}
},
"loginDetails": {
"type": "object",
"properties": {
"animatedLogin": {
"type": "boolean"
},
"isK8S": {
"type": "boolean"
},
"loginStrategy": {
"type": "string",
"enum": [
"form",
"redirect",
"service-account",
"redirect-service-account"
]
},
"redirectRules": {
"type": "array",
"items": {
"$ref": "#/definitions/redirectRule"
}
}
}
},
"loginOauth2AuthRequest": {
"type": "object",
"required": [
"state",
"code"
],
"properties": {
"code": {
"type": "string"
},
"state": {
"type": "string"
}
}
},
"loginRequest": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"features": {
"type": "object",
"properties": {
"hide_menu": {
"type": "boolean"
}
}
},
"secretKey": {
"type": "string"
},
"sts": {
"type": "string"
}
}
},
"loginResponse": {
"type": "object",
"properties": {
"IDPRefreshToken": {
"type": "string"
},
"sessionId": {
"type": "string"
}
}
},
"logoutRequest": {
"type": "object",
"properties": {
"state": {
"type": "string"
}
}
},
"makeBucketRequest": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
}
},
"makeBucketsResponse": {
"type": "object",
"properties": {
"bucketName": {
"type": "string"
}
}
},
"maxShareLinkExpResponse": {
"type": "object",
"required": [
"exp"
],
"properties": {
"exp": {
"type": "number",
"format": "int64"
}
}
},
"metadata": {
"type": "object",
"properties": {
"objectMetadata": {
"type": "object",
"additionalProperties": true
}
}
},
"multiBucketReplication": {
"required": [
"accessKey",
"secretKey",
"targetURL",
"bucketsRelation"
],
"properties": {
"accessKey": {
"type": "string",
"minLength": 3
},
"bandwidth": {
"type": "integer",
"format": "int64"
},
"bucketsRelation": {
"type": "array",
"minLength": 1,
"items": {
"$ref": "#/definitions/multiBucketsRelation"
}
},
"healthCheckPeriod": {
"type": "integer",
"format": "int32"
},
"prefix": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32",
"default": 0
},
"region": {
"type": "string"
},
"replicateDeleteMarkers": {
"type": "boolean"
},
"replicateDeletes": {
"type": "boolean"
},
"replicateExistingObjects": {
"type": "boolean"
},
"replicateMetadata": {
"type": "boolean"
},
"secretKey": {
"type": "string",
"minLength": 8
},
"storageClass": {
"type": "string",
"default": ""
},
"syncMode": {
"type": "string",
"default": "async",
"enum": [
"async",
"sync"
]
},
"tags": {
"type": "string"
},
"targetURL": {
"type": "string"
}
}
},
"multiBucketReplicationEdit": {
"properties": {
"arn": {
"type": "string"
},
"prefix": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32",
"default": 0
},
"replicateDeleteMarkers": {
"type": "boolean"
},
"replicateDeletes": {
"type": "boolean"
},
"replicateExistingObjects": {
"type": "boolean"
},
"replicateMetadata": {
"type": "boolean"
},
"ruleState": {
"type": "boolean"
},
"storageClass": {
"type": "string",
"default": ""
},
"tags": {
"type": "string",
"default": ""
}
}
},
"multiBucketResponseItem": {
"type": "object",
"properties": {
"errorString": {
"type": "string"
},
"originBucket": {
"type": "string"
},
"targetBucket": {
"type": "string"
}
}
},
"multiBucketResponseState": {
"type": "object",
"properties": {
"replicationState": {
"type": "array",
"items": {
"$ref": "#/definitions/multiBucketResponseItem"
}
}
}
},
"multiBucketsRelation": {
"type": "object",
"properties": {
"destinationBucket": {
"type": "string"
},
"originBucket": {
"type": "string"
}
}
},
"nofiticationService": {
"type": "string",
"enum": [
"webhook",
"amqp",
"kafka",
"mqtt",
"nats",
"nsq",
"mysql",
"postgres",
"elasticsearch",
"redis"
]
},
"notifEndpointResponse": {
"type": "object",
"properties": {
"notification_endpoints": {
"type": "array",
"items": {
"$ref": "#/definitions/notificationEndpointItem"
}
}
}
},
"notificationConfig": {
"type": "object",
"required": [
"arn"
],
"properties": {
"arn": {
"type": "string"
},
"events": {
"type": "array",
"title": "filter specific type of event. Defaults to all event (default: '[put,delete,get]')",
"items": {
"$ref": "#/definitions/notificationEventType"
}
},
"id": {
"type": "string"
},
"prefix": {
"type": "string",
"title": "filter event associated to the specified prefix"
},
"suffix": {
"type": "string",
"title": "filter event associated to the specified suffix"
}
}
},
"notificationDeleteRequest": {
"type": "object",
"required": [
"events",
"prefix",
"suffix"
],
"properties": {
"events": {
"type": "array",
"title": "filter specific type of event. Defaults to all event (default: '[put,delete,get]')",
"minLength": 1,
"items": {
"$ref": "#/definitions/notificationEventType"
}
},
"prefix": {
"type": "string",
"title": "filter event associated to the specified prefix"
},
"suffix": {
"type": "string",
"title": "filter event associated to the specified suffix"
}
}
},
"notificationEndpoint": {
"type": "object",
"required": [
"service",
"account_id",
"properties"
],
"properties": {
"account_id": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"service": {
"$ref": "#/definitions/nofiticationService"
}
}
},
"notificationEndpointItem": {
"type": "object",
"properties": {
"account_id": {
"type": "string"
},
"service": {
"$ref": "#/definitions/nofiticationService"
},
"status": {
"type": "string"
}
}
},
"notificationEventType": {
"type": "string",
"enum": [
"put",
"delete",
"get",
"replica",
"ilm",
"scanner"
]
},
"objectLegalHoldStatus": {
"type": "string",
"enum": [
"enabled",
"disabled"
]
},
"objectRetentionMode": {
"type": "string",
"enum": [
"governance",
"compliance"
]
},
"objectRetentionUnit": {
"type": "string",
"enum": [
"days",
"years"
]
},
"peerInfo": {
"type": "object",
"properties": {
"deploymentID": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"peerInfoRemove": {
"type": "object",
"required": [
"sites"
],
"properties": {
"all": {
"type": "boolean"
},
"sites": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"peerSite": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"name": {
"type": "string"
},
"secretKey": {
"type": "string"
}
}
},
"peerSiteEditResponse": {
"type": "object",
"properties": {
"errorDetail": {
"type": "string"
},
"status": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"peerSiteRemoveResponse": {
"type": "object",
"properties": {
"errorDetail": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"permissionResource": {
"type": "object",
"properties": {
"conditionOperator": {
"type": "string"
},
"prefixes": {
"type": "array",
"items": {
"type": "string"
}
},
"resource": {
"type": "string"
}
}
},
"policy": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"policy": {
"type": "string"
}
}
},
"policyArgs": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"bucket_name": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"policyEntity": {
"type": "string",
"default": "user",
"enum": [
"user",
"group"
]
},
"prefixAccessPair": {
"type": "object",
"properties": {
"access": {
"type": "string"
},
"prefix": {
"type": "string"
}
}
},
"prefixWrapper": {
"type": "object",
"properties": {
"prefix": {
"type": "string"
}
}
},
"principal": {
"type": "object",
"properties": {
"STSAccessKeyID": {
"type": "string"
},
"STSSecretAccessKey": {
"type": "string"
},
"STSSessionToken": {
"type": "string"
},
"accountAccessKey": {
"type": "string"
},
"customStyleOb": {
"type": "string"
},
"hm": {
"type": "boolean"
},
"ob": {
"type": "boolean"
}
}
},
"profilingStartRequest": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
}
}
},
"putBucketRetentionRequest": {
"type": "object",
"required": [
"mode",
"unit",
"validity"
],
"properties": {
"mode": {
"$ref": "#/definitions/objectRetentionMode"
},
"unit": {
"$ref": "#/definitions/objectRetentionUnit"
},
"validity": {
"type": "integer",
"format": "int32"
}
}
},
"putBucketTagsRequest": {
"type": "object",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
}
}
}
},
"putObjectLegalHoldRequest": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"$ref": "#/definitions/objectLegalHoldStatus"
}
}
},
"putObjectRetentionRequest": {
"type": "object",
"required": [
"mode",
"expires"
],
"properties": {
"expires": {
"type": "string"
},
"governance_bypass": {
"type": "boolean"
},
"mode": {
"$ref": "#/definitions/objectRetentionMode"
}
}
},
"putObjectTagsRequest": {
"type": "object",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
}
}
}
},
"redirectRule": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"redirect": {
"type": "string"
},
"serviceType": {
"type": "string"
}
}
},
"releaseAuthor": {
"type": "object",
"properties": {
"avatar_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"receivedEvents_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"releaseInfo": {
"type": "object",
"properties": {
"breakingChangesContent": {
"type": "string"
},
"contextContent": {
"type": "string"
},
"metadata": {
"$ref": "#/definitions/releaseMetadata"
},
"newFeaturesContent": {
"type": "string"
},
"notesContent": {
"type": "string"
},
"securityContent": {
"type": "string"
}
}
},
"releaseListResponse": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/releaseInfo"
}
}
}
},
"releaseMetadata": {
"type": "object",
"properties": {
"assets_url": {
"type": "string"
},
"author": {
"$ref": "#/definitions/releaseAuthor"
},
"created_at": {
"type": "string"
},
"draft": {
"type": "boolean"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"prerelease": {
"type": "boolean"
},
"published_at": {
"type": "string"
},
"tag_name": {
"type": "string"
},
"tarball_url": {
"type": "string"
},
"target_commitish": {
"type": "string"
},
"upload_url": {
"type": "string"
},
"url": {
"type": "string"
},
"zipball_url": {
"type": "string"
}
}
},
"remoteBucket": {
"type": "object",
"required": [
"accessKey",
"sourceBucket",
"remoteARN"
],
"properties": {
"accessKey": {
"type": "string",
"minLength": 3
},
"bandwidth": {
"type": "integer",
"format": "int64"
},
"healthCheckPeriod": {
"type": "integer"
},
"remoteARN": {
"type": "string"
},
"secretKey": {
"type": "string",
"minLength": 8
},
"service": {
"type": "string",
"enum": [
"replication"
]
},
"sourceBucket": {
"type": "string"
},
"status": {
"type": "string"
},
"syncMode": {
"type": "string"
},
"targetBucket": {
"type": "string"
},
"targetURL": {
"type": "string"
}
}
},
"resultTarget": {
"type": "object",
"properties": {
"legendFormat": {
"type": "string"
},
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/widgetResult"
}
},
"resultType": {
"type": "string"
}
}
},
"rewindItem": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"delete_flag": {
"type": "boolean"
},
"is_latest": {
"type": "boolean"
},
"last_modified": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
},
"version_id": {
"type": "string"
}
}
},
"rewindResponse": {
"type": "object",
"properties": {
"objects": {
"type": "array",
"items": {
"$ref": "#/definitions/rewindItem"
}
}
}
},
"selectedSAs": {
"type": "array",
"items": {
"type": "string"
}
},
"selectedUsers": {
"type": "array",
"items": {
"type": "string"
}
},
"serverDrives": {
"type": "object",
"properties": {
"availableSpace": {
"type": "integer"
},
"drivePath": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"healing": {
"type": "boolean"
},
"model": {
"type": "string"
},
"rootDisk": {
"type": "boolean"
},
"state": {
"type": "string"
},
"totalSpace": {
"type": "integer"
},
"usedSpace": {
"type": "integer"
},
"uuid": {
"type": "string"
}
}
},
"serverProperties": {
"type": "object",
"properties": {
"commitID": {
"type": "string"
},
"drives": {
"type": "array",
"items": {
"$ref": "#/definitions/serverDrives"
}
},
"endpoint": {
"type": "string"
},
"network": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"poolNumber": {
"type": "integer"
},
"state": {
"type": "string"
},
"uptime": {
"type": "integer"
},
"version": {
"type": "string"
}
}
},
"serviceAccount": {
"type": "object",
"properties": {
"accountStatus": {
"type": "string"
},
"description": {
"type": "string"
},
"expiration": {
"type": "string"
},
"impliedPolicy": {
"type": "boolean"
},
"name": {
"type": "string"
},
"parentUser": {
"type": "string"
},
"policy": {
"type": "string"
}
}
},
"serviceAccountCreds": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"serviceAccountRequest": {
"type": "object",
"properties": {
"comment": {
"type": "string"
},
"description": {
"type": "string"
},
"expiry": {
"type": "string"
},
"name": {
"type": "string"
},
"policy": {
"type": "string",
"title": "policy to be applied to the Service Account if any"
}
}
},
"serviceAccountRequestCreds": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"comment": {
"type": "string"
},
"description": {
"type": "string"
},
"expiry": {
"type": "string"
},
"name": {
"type": "string"
},
"policy": {
"type": "string",
"title": "policy to be applied to the Service Account if any"
},
"secretKey": {
"type": "string"
}
}
},
"serviceAccounts": {
"type": "array",
"items": {
"$ref": "#/definitions/ServiceAccountsItems0"
}
},
"sessionResponse": {
"type": "object",
"properties": {
"allowResources": {
"type": "array",
"items": {
"$ref": "#/definitions/permissionResource"
}
},
"customStyles": {
"type": "string"
},
"distributedMode": {
"type": "boolean"
},
"envConstants": {
"$ref": "#/definitions/environmentConstants"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"operator": {
"type": "boolean"
},
"permissions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"serverEndPoint": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ok"
]
}
}
},
"setBucketPolicyRequest": {
"type": "object",
"required": [
"access"
],
"properties": {
"access": {
"$ref": "#/definitions/bucketAccess"
},
"definition": {
"type": "string"
}
}
},
"setBucketQuota": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"amount": {
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"quota_type": {
"type": "string",
"enum": [
"hard"
]
}
}
},
"setBucketVersioning": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"excludeFolders": {
"type": "boolean"
},
"excludePrefixes": {
"type": "array",
"maxLength": 10,
"items": {
"type": "string"
}
}
}
},
"setConfigRequest": {
"type": "object",
"required": [
"key_values"
],
"properties": {
"arn_resource_id": {
"type": "string",
"title": "Used if configuration is an event notification's target"
},
"key_values": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/configurationKV"
}
}
}
},
"setConfigResponse": {
"type": "object",
"properties": {
"restart": {
"description": "Returns wheter server needs to restart to apply changes or not",
"type": "boolean"
}
}
},
"setIDPResponse": {
"type": "object",
"properties": {
"restart": {
"type": "boolean"
}
}
},
"setNotificationEndpointResponse": {
"type": "object",
"required": [
"service",
"account_id",
"properties"
],
"properties": {
"account_id": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"restart": {
"type": "boolean"
},
"service": {
"$ref": "#/definitions/nofiticationService"
}
}
},
"setPolicyMultipleNameRequest": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/definitions/iamEntity"
}
},
"name": {
"type": "array",
"items": {
"type": "string"
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/iamEntity"
}
}
}
},
"setPolicyNameRequest": {
"type": "object",
"required": [
"name",
"entityType",
"entityName"
],
"properties": {
"entityName": {
"type": "string"
},
"entityType": {
"$ref": "#/definitions/policyEntity"
},
"name": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"setPolicyRequest": {
"type": "object",
"required": [
"entityType",
"entityName"
],
"properties": {
"entityName": {
"type": "string"
},
"entityType": {
"$ref": "#/definitions/policyEntity"
}
}
},
"siteReplicationAddRequest": {
"type": "array",
"items": {
"$ref": "#/definitions/peerSite"
}
},
"siteReplicationAddResponse": {
"type": "object",
"properties": {
"errorDetail": {
"type": "string"
},
"initialSyncErrorMessage": {
"type": "string"
},
"status": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"siteReplicationInfoResponse": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"serviceAccountAccessKey": {
"type": "string"
},
"sites": {
"type": "array",
"items": {
"$ref": "#/definitions/peerInfo"
}
}
}
},
"siteReplicationStatusResponse": {
"type": "object",
"properties": {
"bucketStats": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"groupStats": {
"type": "object"
},
"maxBuckets": {
"type": "integer"
},
"maxGroups": {
"type": "integer"
},
"maxPolicies": {
"type": "integer"
},
"maxUsers": {
"type": "integer"
},
"policyStats": {
"type": "object"
},
"sites": {
"type": "object"
},
"statsSummary": {
"type": "object"
},
"userStats": {
"type": "object"
}
}
},
"startProfilingItem": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"nodeName": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"startProfilingList": {
"type": "object",
"properties": {
"startResults": {
"type": "array",
"items": {
"$ref": "#/definitions/startProfilingItem"
}
},
"total": {
"type": "integer",
"format": "int64",
"title": "number of start results"
}
}
},
"updateGroupRequest": {
"type": "object",
"required": [
"members",
"status"
],
"properties": {
"members": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
}
}
},
"updateServiceAccountRequest": {
"type": "object",
"required": [
"policy"
],
"properties": {
"description": {
"type": "string"
},
"expiry": {
"type": "string"
},
"name": {
"type": "string"
},
"policy": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"updateUser": {
"type": "object",
"required": [
"status",
"groups"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
}
}
},
"updateUserGroups": {
"type": "object",
"required": [
"groups"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"user": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"hasPolicy": {
"type": "boolean"
},
"memberOf": {
"type": "array",
"items": {
"type": "string"
}
},
"policy": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
}
}
},
"userSAs": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"recursive": {
"type": "boolean"
},
"versionID": {
"type": "string"
}
}
},
"userServiceAccountItem": {
"type": "object",
"properties": {
"numSAs": {
"type": "integer",
"format": "int64"
},
"userName": {
"type": "string"
}
}
},
"userServiceAccountSummary": {
"type": "object",
"properties": {
"hasSA": {
"type": "boolean"
},
"userServiceAccountList": {
"type": "array",
"title": "list of users with number of service accounts",
"items": {
"$ref": "#/definitions/userServiceAccountItem"
}
}
}
},
"widget": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"options": {
"type": "object",
"properties": {
"reduceOptions": {
"type": "object",
"properties": {
"calcs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"targets": {
"type": "array",
"items": {
"$ref": "#/definitions/resultTarget"
}
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"widgetDetails": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"options": {
"type": "object",
"properties": {
"reduceOptions": {
"type": "object",
"properties": {
"calcs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"targets": {
"type": "array",
"items": {
"$ref": "#/definitions/resultTarget"
}
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"widgetResult": {
"type": "object",
"properties": {
"metric": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"values": {
"type": "array",
"items": {}
}
}
}
},
"parameters": {
"limit": {
"type": "number",
"format": "int32",
"default": 20,
"name": "limit",
"in": "query"
},
"offset": {
"type": "number",
"format": "int32",
"default": 0,
"name": "offset",
"in": "query"
}
},
"securityDefinitions": {
"anonymous": {
"type": "apiKey",
"name": "X-Anonymous",
"in": "header"
},
"key": {
"type": "oauth2",
"flow": "accessCode",
"authorizationUrl": "http://min.io",
"tokenUrl": "http://min.io"
}
},
"security": [
{
"key": []
}
]
}`))
}