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

200
default

Content type

application/json; charset=UTF-8

Copy

Expand all Collapse all


[
{"name": "string",
"creationDate": "string"
}
]

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

200
default

Content type

application/json; charset=UTF-8

Copy

Expand all Collapse all


[
{"events": 
{"XMLname": 
{"Space": "string",
"Local": "string"
},
"LambdaConfigs": { },
"TopicConfigs": { },
"QueueConfigs": { }
},
"info": 
{"name": "string",
"creationDate": "string"
},
"quota": 
{"quota": 0,
"quotatype": "string"
},
"tags": { },
"policy": "string"
}
]

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

200
default

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

post/bucket/delete

http://localhost:8080/api/v2/bucket/delete

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all


{"Success": "OK"
}

remove bucket events notifications

Request Body schema: multipart/form-data

bucket

string <string>

Responses

200

Success

default

unexpected error

post/bucket/remove-events

http://localhost:8080/api/v2/bucket/remove-events

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all


{"Success": "OK"
}

Set bucket events

Request Body schema: multipart/form-data

bucket	string <string>
eventTypes	string <string>
filterPrefix	string <string>
filterSuffix	string <string>

Responses

200

lifecycle XML string or empty string if lifecycle does not exist

default

unexpected error

post/bucket/set-events

http://localhost:8080/api/v2/bucket/set-events

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all


{"Success": "OK"
}

Get bucket events

Request Body schema: multipart/form-data

bucket

string <string>

Responses

200

return bucket event

default

unexpected error

post/bucket/get-events

http://localhost:8080/api/v2/bucket/get-events

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all


{"XMLname": 
{"Space": "string",
"Local": "string"
},
"LambdaConfigs": { },
"TopicConfigs": { },
"QueueConfigs": { }
}

Get bucket lifecycle

Request Body schema: multipart/form-data

bucketName

string <string>

Responses

200

lifecycle XML string or empty string if lifecycle does not exist

default

unexpected error

post/bucket/get-lifecycle

http://localhost:8080/api/v2/bucket/get-lifecycle

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all

"string"

Set bucket lifecycle

Request Body schema: multipart/form-data

bucketName	string <string>
lifecycle	string <string> lifecycle XML string

Responses

200

Success

default

unexpected error

post/bucket/set-lifecycle

http://localhost:8080/api/v2/bucket/set-lifecycle

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all


{"Success": "OK"
}

Set bucket quota

Request Body schema: multipart/form-data

bucketName	string <string>
quotaType	string <string>
quotaValue	string <string> quota size in bytes

Responses

200

Success

default

unexpected error

post/bucket/set-quota

http://localhost:8080/api/v2/bucket/set-quota

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all


{"Success": "OK"
}

Get bucket quota

Request Body schema: multipart/form-data

bucketName

string <string>

Responses

200

bucket quota

default

unexpected error

post/bucket/get-quota

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

Response samples

200
default

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

200
default

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

200
default

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

200
default

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

200
default

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

200
default

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

200
default

Content type

application/json; charset=UTF-8

Copy

Expand all Collapse all


{"name": 
{"policyName": "string",
"status": "string"
}
}

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

200
default

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

200
default

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

200
default

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

200
default

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

200
default

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

200
default

Content type

application/json; charset=UTF-8

Copy

Expand all Collapse all


{"name": 
{"Version": "string",
"Statement": 
[
{"Effect": "string",
"Action": 
["string"
],
"Resource": 
["string"
]
}
]
}
}

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

200
default

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

200
default

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

200
default

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

200
default

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

200
default

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"status": "string",
"members": 
["string"
],
"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

200
default

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

200
default

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

200
default

Content type

application/json; charset=UTF-8

Copy

Expand all Collapse all


{"mode": "string",
"sqsARN": 
["string"
],
"deploymentID": "string",
"buckets": 
{"count": 0
},
"objects": 
{"count": 0
},
"usage": 
{"size": 0
},
"services": 
{"vault": 
{"status": "string"
},
"ldap": { },
"notifications": 
[
{"kafka": 
[{ }
]
}
]
},
"backend": 
{"backendType": "string"
},
"servers": 
[
{"state": "string",
"endpoint": "string",
"uptime": "string",
"version": "string",
"commitID": "string",
"network": { },
"disks": 
[
{"path": "string",
"state": "string",
"totalspace": "string",
"usedspace": "string"
}
]
}
]
}

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

200
default

Content type

application/json; charset=UTF-8

Copy

Expand all Collapse all


{"lastUpdate": "string",
"objectsCount": 0,
"objectsTotalSize": 0,
"objectsSizesHistogram": 
{"BETWEEN_1024_B_AND_1_MB": 0,
"BETWEEN_10_MB_AND_64_MB": 0,
"BETWEEN_128_MB_AND_512_MB": 0,
"BETWEEN_1_MB_AND_10_MB": 0,
"BETWEEN_64_MB_AND_128_MB": 0,
"GREATER_THAN_512_MB": 0,
"LESS_THAN_1024_B": 0
},
"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

200
default

Content type

application/json

Copy

Expand all Collapse all

"string"