Gamma API

Test a storage connection

POST
/api/organizations/{slug}/storage/test

Runs the checks a save runs — writes a file to the bucket and deletes it — and saves nothing. Refused with 400 saying why it failed.

Who may call it: An owner or security admin of the organization. API keys: no.

Authorization

session
cookiegamma.session_token<token>

The session cookie a sign-in sets. Over HTTPS its name carries the __Secure- prefix. Browsers send it on their own; other clients keep it from the sign-in response.

Path Parameters

slug*string

The organization's slug, as in its URL.

Request Body

application/json
  1. body
bucket*string
Length1 <= length <= 63
region*string
Length1 <= length <= 64
endpoint?||

An S3-compatible endpoint, public and https; empty or absent for AWS.

prefix?string

Where in the bucket files go; empty for the whole bucket.

Default""
accessKeyId*string
Length1 <= length
secretAccessKey?string

Required on a first connection or a new endpoint; left out or empty, the saved one is kept.

Response Body

OK.

application/json
  1. response
ok*boolean
Example Request
curl -X POST 'http://localhost:3000/api/organizations/string/storage/test' \  -H 'Content-Type: application/json' \  -d '{  "bucket": "string",  "region": "string",  "accessKeyId": "string"}'
Example Response
{  "ok": true}