diff --git a/openAPI/openapi.html b/openAPI/openapi.html index 99e9b04..a80767b 100644 --- a/openAPI/openapi.html +++ b/openAPI/openapi.html @@ -280,7 +280,7 @@ -
Documentation Powered by ReDoc
Documentation Powered by ReDoc

Adminio API (2.0.0)

Download OpenAPI specification:Download

URL: https://github.com/rzrbld/adminio-api/issues License: MIT

Adminio API

+ " fill="currentColor">

Adminio API (2.3.0)

Download OpenAPI specification:Download

URL: https://github.com/rzrbld/adminio-api/issues License: MIT

Adminio API

bucket

List all buckets

Responses

200

List all buckets

default

unexpected error

get/buckets/list
http://localhost:8080/api/v2/buckets/list

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
[
  • {
    }
]

List all buckets with ARN's and Quota's

Responses

200

List all buckets plus ARN and Quota

default

unexpected error

-
get/buckets/list-extended
http://localhost:8080/api/v2/buckets/list-extended

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
[
  • {
    }
]

Create a bucket

Request Body schema: multipart/form-data
newBucket
string <string>
newBucketRegion
string <string>

Responses

200

Success

+
get/buckets/list-extended
http://localhost:8080/api/v2/buckets/list-extended

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
[
  • {
    }
]

Create a bucket

Request Body schema: multipart/form-data
newBucket
string <string>
newBucketRegion
string <string>

Responses

200

Success

default

unexpected error

post/bucket/create
http://localhost:8080/api/v2/bucket/create

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Delete bucket

Request Body schema: multipart/form-data
bucketName
string <string>

Responses

200

Success

default

unexpected error

@@ -325,51 +325,61 @@
default

unexpected error

post/bucket/get-quota
http://localhost:8080/api/v2/bucket/get-quota

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "quota": 0,
  • "quotatype": "string"
}

Remove bucket quota

Request Body schema: multipart/form-data
bucketName
string <string>

Responses

200

Success

default

unexpected error

-
post/bucket/remove-quota
http://localhost:8080/api/v2/bucket/remove-quota

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

user

List all users

Responses

200

List all users

+
post/bucket/remove-quota
http://localhost:8080/api/v2/bucket/remove-quota

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Set bucket tags

Request Body schema: multipart/form-data
bucketName
string <string>
bucketTags
string <string>

comma separated list of tags. e.g. tag1=value1&tag2=value2

+

Responses

200

Success

+
default

unexpected error

+
post/bucket/set-tags
http://localhost:8080/api/v2/bucket/set-tags

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Get bucket tags

Request Body schema: multipart/form-data
bucketName
string <string>

Responses

200

bucket tags

+
default

unexpected error

+
post/bucket/get-tags
http://localhost:8080/api/v2/bucket/get-tags

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get bucket policy

Request Body schema: multipart/form-data
bucketName
string <string>

Responses

200

bucket policy

+
default

unexpected error

+
post/bucket/get-policy
http://localhost:8080/api/v2/bucket/get-policy

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policy": "string",
  • "name": "string"
}

Set bucket policy

Request Body schema: multipart/form-data
bucketName
string <string>
bucketPolicy
string <string>

predefined values none, upload, download, public or custom json string

+

Responses

200

Success

+
default

unexpected error

+
post/bucket/set-policy
http://localhost:8080/api/v2/bucket/set-policy

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

user

List all users

Responses

200

List all users

default

unexpected error

-
get/users/list
http://localhost:8080/api/v2/users/list

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "name":
    {
    }
}

Set User status

Request Body schema: multipart/form-data
accessKey
string <string>
status
string <string>
Enum: "enabled" "disabled"

Responses

200

Success

+
get/users/list
http://localhost:8080/api/v2/users/list

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "name":
    {
    }
}

Set User status

Request Body schema: multipart/form-data
accessKey
string <string>
status
string <string>
Enum: "enabled" "disabled"

Responses

200

Success

default

unexpected error

-
post/user/set-status
http://localhost:8080/api/v2/user/set-status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Delete User

Request Body schema: multipart/form-data
accessKey
string <string>

Responses

200

Success

+
post/user/set-status
http://localhost:8080/api/v2/user/set-status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Delete User

Request Body schema: multipart/form-data
accessKey
string <string>

Responses

200

Success

default

unexpected error

-
post/user/delete
http://localhost:8080/api/v2/user/delete

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Create User

Request Body schema: multipart/form-data
accessKey
string <string>
secretKey
string <string>

Responses

200

Success

+
post/user/delete
http://localhost:8080/api/v2/user/delete

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Create User

Request Body schema: multipart/form-data
accessKey
string <string>
secretKey
string <string>

Responses

200

Success

default

unexpected error

-
post/user/create
http://localhost:8080/api/v2/user/create

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Create User with bounded policy

Request Body schema: multipart/form-data
accessKey
string <string>
secretKey
string <string>
policyName
string <string>

Responses

200

Success

+
post/user/create
http://localhost:8080/api/v2/user/create

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Create User with bounded policy

Request Body schema: multipart/form-data
accessKey
string <string>
secretKey
string <string>
policyName
string <string>

Responses

200

Success

default

unexpected error

-
post/user/create-extended
http://localhost:8080/api/v2/user/create-extended

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Update User - change policy or status

Request Body schema: multipart/form-data
accessKey
string <string>
secretKey
string <string>
policyName
string <string>
status
string <string>
Enum: "enabled" "disabled"

Responses

200

Success

+
post/user/create-extended
http://localhost:8080/api/v2/user/create-extended

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Update User - change policy or status

Request Body schema: multipart/form-data
accessKey
string <string>
secretKey
string <string>
policyName
string <string>
status
string <string>
Enum: "enabled" "disabled"

Responses

200

Success

default

unexpected error

-
post/user/update
http://localhost:8080/api/v2/user/update

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

policy

List all policies

Responses

200

List all policies

+
post/user/update
http://localhost:8080/api/v2/user/update

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

policy

List all policies

Responses

200

List all policies

default

unexpected error

-
get/policies/list
http://localhost:8080/api/v2/policies/list

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "name":
    {
    }
}

Create policy

Request Body schema: multipart/form-data
policyName
string <string>
policyString
string <string>

Responses

200

Success

+
get/policies/list
http://localhost:8080/api/v2/policies/list

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "name":
    {
    }
}

Create policy

Request Body schema: multipart/form-data
policyName
string <string>
policyString
string <string>

Responses

200

Success

default

unexpected error

-
post/policy/create
http://localhost:8080/api/v2/policy/create

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Delete policy

Request Body schema: multipart/form-data
policyName
string <string>

Responses

200

Success

+
post/policy/create
http://localhost:8080/api/v2/policy/create

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Delete policy

Request Body schema: multipart/form-data
policyName
string <string>

Responses

200

Success

default

unexpected error

-
post/policy/delete
http://localhost:8080/api/v2/policy/delete

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Bound policy to user or group

Request Body schema: multipart/form-data
policyName
string <string>

Ploicy Name

+
post/policy/delete
http://localhost:8080/api/v2/policy/delete

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Bound policy to user or group

Request Body schema: multipart/form-data
policyName
string <string>

Ploicy Name

entityName
string <string>

Group or User name

isGroup
boolean <boolean>
Enum: true false

Responses

200

Success

default

unexpected error

-
post/policy/update
http://localhost:8080/api/v2/policy/update

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

group

Group set status

Request Body schema: multipart/form-data
group
string <string>

Group Name

+
post/policy/update
http://localhost:8080/api/v2/policy/update

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

group

Group set status

Request Body schema: multipart/form-data
group
string <string>

Group Name

status
boolean <boolean>
Enum: "enabled" "disabled"

Responses

200

Success

default

unexpected error

-
post/group/set-status
http://localhost:8080/api/v2/group/set-status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Group get description

Request Body schema: multipart/form-data
group
string <string>

Group Name

+
post/group/set-status
http://localhost:8080/api/v2/group/set-status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

Group get description

Request Body schema: multipart/form-data
group
string <string>

Group Name

Responses

200

Success

default

unexpected error

-
post/group/get-description
http://localhost:8080/api/v2/group/get-description

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "status": "string",
  • "members":
    [
    ],
  • "policy": "string"
}

Update Group members

Request Body schema: multipart/form-data
group
string <string>

Group Name

+
post/group/get-description
http://localhost:8080/api/v2/group/get-description

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "status": "string",
  • "members":
    [
    ],
  • "policy": "string"
}

Update Group members

Request Body schema: multipart/form-data
group
string <string>

Group Name

members
string <string>

multiple usernames with comma delimiter

IsRemove
boolean <boolean>
Enum: true false

set false if you need remove members from group

Responses

200

Success

default

unexpected error

-
post/group/update-members
http://localhost:8080/api/v2/group/update-members

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

List all groups

Responses

200

List all groups

+
post/group/update-members
http://localhost:8080/api/v2/group/update-members

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Success": "OK"
}

List all groups

Responses

200

List all groups

default

unexpected error

-
get/groups/list
http://localhost:8080/api/v2/groups/list

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
[
  • "string"
]

server

Server basic info

Responses

200

Server Info

+
get/groups/list
http://localhost:8080/api/v2/groups/list

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
[
  • "string"
]

server

Server basic info

Responses

200

Server Info

default

unexpected error

-
get/server/common-info
http://localhost:8080/api/v2/server/common-info

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "mode": "string",
  • "sqsARN":
    [
    ],
  • "deploymentID": "string",
  • "buckets":
    {
    },
  • "objects":
    {
    },
  • "usage":
    {
    },
  • "services":
    {
    },
  • "backend":
    {
    },
  • "servers":
    [
    ]
}

Server disk info

Responses

200

Server Disk Info

+
get/server/common-info
http://localhost:8080/api/v2/server/common-info

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "mode": "string",
  • "sqsARN":
    [
    ],
  • "deploymentID": "string",
  • "buckets":
    {
    },
  • "objects":
    {
    },
  • "usage":
    {
    },
  • "services":
    {
    },
  • "backend":
    {
    },
  • "servers":
    [
    ]
}

Server disk info

Responses

200

Server Disk Info

default

unexpected error

-
get/server/disk-info
http://localhost:8080/api/v2/server/disk-info

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "lastUpdate": "string",
  • "objectsCount": 0,
  • "objectsTotalSize": 0,
  • "objectsSizesHistogram":
    {
    },
  • "bucketsCount": 0,
  • "bucketsSizes": { }
}

kv

get value by key

Request Body schema: multipart/form-data
keyString
string <string>

Group Name

+
get/server/disk-info
http://localhost:8080/api/v2/server/disk-info

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "lastUpdate": "string",
  • "objectsCount": 0,
  • "objectsTotalSize": 0,
  • "objectsSizesHistogram":
    {
    },
  • "bucketsCount": 0,
  • "bucketsSizes": { }
}

kv

get value by key

Request Body schema: multipart/form-data
keyString
string <string>

Group Name

Responses

200

base64 string

default

unexpected error

-
post/kv/get
http://localhost:8080/api/v2/kv/get

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"
+
post/kv/get
http://localhost:8080/api/v2/kv/get

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"