Administrate your Garage cluster programatically, including status, layout, keys, buckets, and maintainance tasks.
*Disclaimer:The API is not stable yet, hence its v0 tag. The API can change at any time, and changes can include breaking backward compatibility. Read the changelog and upgrade your scripts before upgrading. Additionnaly, this specification is very early stage and can contain bugs, especially on error return codes/types that are not tested yet. Do not expect a well finished and polished product!*
paths:
/status:
get:
tags:
- Nodes
operationId:"GetNodes"
summary:"Status of this node and other nodes in the cluster"
description:|
Returns the cluster's current status, including:
- ID of the node being queried and its version of the Garage daemon
- Live nodes
- Currently configured cluster layout
- Staged changes to the cluster layout
responses:
'500':
description:|
The server can not answer your request because it is in a bad state
'200':
description:|
Information about the queried node, its environment and the current layout
summary:"Connect target node to other Garage nodes"
description:|
Instructs this Garage node to connect to other Garage nodes at specified `<node_id>@<net_address>`. `node_id` is generated automatically on node start.
The server can not answer your request because it is in a bad state
'400':
description:|
Your request is malformed, check your JSON
'200':
description:|
The request has been handled correctly but it does not mean that all connection requests succeeded; some might have fail, you need to check the body!
content:
application/json:
schema:
type:array
example:
- success:true
error:
- success:false
error:"Handshake error"
items:
type:object
properties:
success:
type:boolean
example:true
error:
type:string
nullable:true
example:
/layout:
get:
tags:
- Layout
operationId:"GetLayout"
summary:"Details on the current and staged layout"
description:|
Returns the cluster's current layout, including:
- Currently configured cluster layout
- Staged changes to the cluster layout
*Theinfo returned by this endpoint is a subset of the info returned by `GET /status`.*
responses:
'500':
description:|
The server can not answer your request because it is in a bad state
'200':
description:|
Returns the cluster's current cluster layout:
- Currently configured cluster layout
- Staged changes to the cluster layout
content:
application/json:
schema:
$ref:'#/components/schemas/ClusterLayout'
post:
tags:
- Layout
operationId:"AddLayout"
summary:"Send modifications to the cluster layout"
description:|
Send modifications to the cluster layout. These modifications will be included in the staged role changes, visible in subsequent calls of `GET /layout`. Once the set of staged changes is satisfactory, the user may call `POST /layout/apply` to apply the changed changes, or `POST /layout/revert` to clear all of the staged changes in the layout.
Note that setting the capacity to `null` will configure the node as a gateway.
requestBody:
description:|
To add a new node to the layout or to change the configuration of an existing node, simply set the values you want.
To remove a node, set it to `null` instead of passing a configuration object.
Contrary to the CLI that may update only a subset of the fields capacity, zone and tags, when calling this API all of these values must be specified.
description:"The server can not handle your request. Check your connectivity with the rest of the cluster."
'400':
description:"Invalid syntax or requested change"
'200':
description:"The layout modification has been correctly staged"
/layout/apply:
post:
tags:
- Layout
operationId:"ApplyLayout"
summary:"Apply staged layout"
description:|
Applies to the cluster the layout changes currently registered as staged layout changes.
requestBody:
description:|
Similarly to the CLI, the body must include the version of the new layout that will be created, which MUST be 1 + the value of the currently existing layout in the cluster.
required:true
content:
application/json:
schema:
$ref:'#/components/schemas/LayoutVersion'
responses:
'500':
description:"The server can not handle your request. Check your connectivity with the rest of the cluster."
'400':
description:"Invalid syntax or requested change"
'200':
description:"The staged layout has been applied as the new layout of the cluster, a rebalance has been triggered."
/layout/revert:
post:
tags:
- Layout
operationId:"RevertLayout"
summary:"Clear staged layout"
description:|
Clears all of the staged layout changes.
requestBody:
description:|
Reverting the staged changes is done by incrementing the version number and clearing the contents of the staged change list. Similarly to the CLI, the body must include the incremented version number, which MUST be 1 + the value of the currently existing layout in the cluster.
required:true
content:
application/json:
schema:
$ref:'#/components/schemas/LayoutVersion'
responses:
'500':
description:"The server can not handle your request. Check your connectivity with the rest of the cluster."
'400':
description:"Invalid syntax or requested change"
'200':
description:"The staged layout has been cleared, you can start again sending modification from a fresh copy with `POST /layout`."
/key:
get:
tags:
- Key
operationId:"ListKeys"
summary:"List all keys"
description:|
Returns all API access keys in the cluster.
responses:
'500':
description:"The server can not handle your request. Check your connectivity with the rest of the cluster."
'200':
description:|
Returns the key identifier (aka `AWS_ACCESS_KEY_ID`) and its associated, human friendly, name if any (otherwise return an empty string)
content:
application/json:
schema:
type:array
example:
- id:"GK31c2f218a2e44f485b94239e"
name:"test-key"
- id:"GKe10061ac9c2921f09e4c5540"
name:""
items:
type:object
required:[id ]
properties:
id:
type:string
name:
type:string
post:
tags:
- Key
operationId:"AddKey"
summary:"Create a new API key"
description:|
Creates a new API access key.
requestBody:
description:|
"You can set a friendly name for this key, send an empty string instead"
required:true
content:
application/json:
schema:
type:object
properties:
name:
type:string
example:"test-key"
responses:
'500':
description:"The server can not handle your request. Check your connectivity with the rest of the cluster."
'400':
description:"Invalid syntax or requested change"
'200':
description:"The key has been added"
content:
application/json:
schema:
$ref:'#/components/schemas/KeyInfo'
"/key?id={access_key}":
get:
tags:
- Key
operationId:"GetKey"
summary:"Get key information"
description:|
Return information about a specific key and return its information
parameters:
- name:access_key
in:path
required:true
description:"The exact API access key generated by Garage"
example:"GK31c2f218a2e44f485b94239e"
schema:
type:string
responses:
'500':
description:"The server can not handle your request. Check your connectivity with the rest of the cluster."
'200':
description:|
Returns information about the key
content:
application/json:
schema:
$ref:'#/components/schemas/KeyInfo'
delete:
tags:
- Key
operationId:"DeleteKey"
summary:"Delete a key"
description:|
Delete a key from the cluster. Its access will be removed from all the buckets. Buckets are not automatically deleted and can be dangling. You should manually delete them before.
parameters:
- name:access_key
in:path
required:true
description:"The exact API access key generated by Garage"
example:"GK31c2f218a2e44f485b94239e"
schema:
type:string
responses:
'500':
description:"The server can not handle your request. Check your connectivity with the rest of the cluster."
'200':
description:"The key has been deleted"
post:
tags:
- Key
operationId:"UpdateKey"
summary:"Update a key"
description:|
Updates information about the specified API access key.
parameters:
- name:access_key
in:path
required:true
description:"The exact API access key generated by Garage"
example:"GK31c2f218a2e44f485b94239e"
schema:
type:string
requestBody:
description:|
For a given key, provide a first set with the permissions to grant, and a second set with the permissions to remove
required:true
content:
application/json:
schema:
type:object
properties:
name:
type:string
example:"test-key"
allow:
type:object
example:
properties:
createBucket:
type:boolean
example:true
deny:
type:object
properties:
createBucket:
type:boolean
example:true
responses:
'500':
description:"The server can not handle your request. Check your connectivity with the rest of the cluster."
'400':
description:"Invalid syntax or requested change"
'200':
description:|
Returns information about the key
content:
application/json:
schema:
$ref:'#/components/schemas/KeyInfo'
"/key?search={pattern}":
get:
tags:
- Key
operationId:"SearchKey"
summary:"Select key by pattern"
description:|
Find the first key matching the given pattern based on its identifier aor friendly name and return its information.
parameters:
- name:pattern
in:path
required:true
description:"A pattern (beginning or full string) corresponding to a key identifier or friendly name"
example:"test-k"
schema:
type:string
responses:
'500':
description:"The server can not handle your request. Check your connectivity with the rest of the cluster."
'200':
description:|
Returns information about the key
content:
application/json:
schema:
$ref:'#/components/schemas/KeyInfo'
/key/import:
post:
tags:
- Key
operationId:"ImportKey"
summary:"Import an existing key"
description:|
Imports an existing API key. This feature must only be used for migrations and backup restore.
**Donot use it to generate custom key identifiers or you will break your Garage cluster.**
Requested changes on the bucket. Both root fields are optionals.
required:true
content:
application/json:
schema:
type:object
required:[]
properties:
websiteAccess:
type:object
properties:
enabled:
type:boolean
example:true
indexDocument:
type:string
example:"index.html"
errorDocument:
type:string
example:"error/400.html"
quotas:
type:object
properties:
maxSize:
type:integer
format:int64
nullable:true
example:19029801
maxObjects:
type:integer
format:int64
nullable:true
example:null
responses:
'500':
description:"The server can not handle your request. Check your connectivity with the rest of the cluster."
'400':
description:"Bad request, check your body."
'404':
description:"Bucket not found"
'200':
description:Returns exhaustive information about the bucket
content:
application/json:
schema:
$ref:'#/components/schemas/BucketInfo'
"/bucket?globalAlias={alias}":
get:
tags:
- Bucket
operationId:"FindBucketInfo"
summary:"Find a bucket"
description:|
Find a bucket by its global alias
parameters:
- name:alias
in:path
required:true
description:"The exact global alias of one of the existing buckets"
example:"my_documents"
schema:
type:string
responses:
'500':
description:"The server can not handle your request. Check your connectivity with the rest of the cluster."
'404':
description:"Bucket not found"
'200':
description:Returns exhaustive information about the bucket
content:
application/json:
schema:
$ref:'#/components/schemas/BucketInfo'
/bucket/allow:
post:
tags:
- Bucket
operationId:"AllowBucketKey"
summary:"Allow key"
description:|
⚠️ **DISCLAIMER**:Garage's developers are aware that this endpoint has an unconventional semantic. Be extra careful when implementing it, its behavior is not obvious.
Allows a key to do read/write/owner operations on a bucket.
Flags in permissions which have the value true will be activated. Other flags will remain unchanged (ie. they will keep their internal value).
For example, if you set read to true, the key will be allowed to read the bucket.
If you set it to false, the key will keeps its previous read permission.
If you want to disallow read for the key, check the DenyBucketKey operation.
description:"The server can not handle your request. Check your connectivity with the rest of the cluster."
'400':
description:"Bad request, check your request body"
'404':
description:"Bucket not found"
'200':
description:Returns exhaustive information about the bucket
content:
application/json:
schema:
$ref:'#/components/schemas/BucketInfo'
/bucket/deny:
post:
tags:
- Bucket
operationId:"DenyBucketKey"
summary:"Deny key"
description:|
⚠️ **DISCLAIMER**:Garage's developers are aware that this endpoint has an unconventional semantic. Be extra careful when implementing it, its behavior is not obvious.
Denies a key from doing read/write/owner operations on a bucket.
Flags in permissions which have the value true will be deactivated. Other flags will remain unchanged.
For example, if you set read to true, the key will be denied from reading.
If you set read to false, the key will keep its previous permissions.
If you want the key to have the reading permission, check the AllowBucketKey operation.
