Skip to content
Authrim

Test diagnostic log storage connectivity.

POST
/api/admin/diagnostic-logging/test-connection
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/diagnostic-logging/test-connection \
  --header 'Authorization: Bearer <token>'

Create Test Connection in the Diagnostic Logging area. The request body is JSON unless the detailed schema for this operation states otherwise.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Diagnostic logging R2 connection test response.

Media type application/json
object
success
required
boolean
healthy
boolean
latencyMs
number
error
string
message
required
string
details
object
bindingName
string
pathPrefix
string
tenantId
string
key
additional properties
key
additional properties
Example 
{
  "success": true,
  "healthy": true,
  "latencyMs": 42,
  "message": "R2 connection successful",
  "details": {
    "bindingName": "DIAGNOSTIC_LOGS",
    "pathPrefix": "diagnostic-logs",
    "tenantId": "default"
  }
}

404

Section titled “404 ”

Diagnostic logging R2 connection test response.

Media type application/json
object
success
required
boolean
healthy
boolean
latencyMs
number
error
string
message
required
string
details
object
bindingName
string
pathPrefix
string
tenantId
string
key
additional properties
key
additional properties
Example 
{
  "success": true,
  "healthy": true,
  "latencyMs": 42,
  "message": "R2 connection successful",
  "details": {
    "bindingName": "DIAGNOSTIC_LOGS",
    "pathPrefix": "diagnostic-logs",
    "tenantId": "default"
  }
}

500

Section titled “500 ”

Diagnostic logging R2 connection test response.

Media type application/json
object
success
required
boolean
healthy
boolean
latencyMs
number
error
string
message
required
string
details
object
bindingName
string
pathPrefix
string
tenantId
string
key
additional properties
key
additional properties
Example 
{
  "success": true,
  "healthy": true,
  "latencyMs": 42,
  "message": "R2 connection successful",
  "details": {
    "bindingName": "DIAGNOSTIC_LOGS",
    "pathPrefix": "diagnostic-logs",
    "tenantId": "default"
  }
}

503

Section titled “503 ”

Diagnostic logging R2 connection test response.

Media type application/json
object
success
required
boolean
healthy
boolean
latencyMs
number
error
string
message
required
string
details
object
bindingName
string
pathPrefix
string
tenantId
string
key
additional properties
key
additional properties
Example 
{
  "success": true,
  "healthy": true,
  "latencyMs": 42,
  "message": "R2 connection successful",
  "details": {
    "bindingName": "DIAGNOSTIC_LOGS",
    "pathPrefix": "diagnostic-logs",
    "tenantId": "default"
  }
}