Skip to content
Authrim

Test a storage destination

POST
/api/admin/storage-destinations/{id}/test
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/storage-destinations/example/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Run provider-specific connectivity checks and return an audited action result.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body

Section titled “Request Body ”

Test a storage destination connection.

Media type application/json
object
key
additional properties
Example 
{}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Storage destination connectivity test result.

Media type application/json
object
result
required
object
key
additional properties
audit_id
One of:
string
job_id
string
key
additional properties
Example 
{
  "result": {
    "status": "ok",
    "message": "Connection succeeded.",
    "provider": "r2",
    "checked_at": 1770000000000,
    "details": {}
  },
  "audit_id": "audit_123"
}

400

Section titled “400 ”

Storage destination connectivity test result.

Media type application/json
object
result
required
object
key
additional properties
audit_id
One of:
string
job_id
string
key
additional properties
Example 
{
  "result": {
    "status": "ok",
    "message": "Connection succeeded.",
    "provider": "r2",
    "checked_at": 1770000000000,
    "details": {}
  },
  "audit_id": "audit_123"
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}