Unbind
Storage

Test Stored S3 Bucket

Check that a stored S3 bucket is still reachable with its saved credentials, by writing and deleting a probe object in it. Returns valid=false with the error when it is not. Use it when backups to the bucket fail. Reaches an external endpoint.

POST
/storage/s3/test-stored

Check that a stored S3 bucket is still reachable with its saved credentials, by writing and deleting a probe object in it. Returns valid=false with the error when it is not. Use it when backups to the bucket fail. Reaches an external endpoint.

Authorization

bearerAuth
AuthorizationBearer <token>

Access token or API key (unb_...) passed as Authorization: Bearer <token>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

ID of the S3 bucket, from list-s3-buckets

Formatuuid
team_id*string

ID of the team that owns the S3 bucket

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/storage/s3/test-stored" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba"  }'
{  "data": {    "error": "string",    "valid": true  }}

Test S3 Access POST

Validate S3 credentials that are not stored yet by writing and deleting a probe object in the bucket. Reaches an external endpoint.

List Replicas (Pods) GET

List the running replicas (pods) for a service, environment, project, or team, with health status. Send the ID of the level named by type along with the IDs of every level above it.