Skip to main content
Version: Next

View S3 Provider

This method is intended for viewing an S3 provider.

Request Parameters

GET /api/clients/v1/s3Providers/{id}/

Headers

  • Content-Type: application/json
  • Authorization: Bearer $access_token

Path

ParameterTypeConstraintsDescriptionExample
idinteger> 0, requiredProvider ID2

Response Parameters

Examples

200 OK

Provider object

{
"id": 2,
"name": "google",
"bucket_naming_rule_description": "s3-hostname.com/bucket"
}
400 Bad Request

Invalid path parameters specified

{
"id": [
"A valid integer is required."
]
}
401 Unauthorized

Authentication credentials are missing or invalid

{
"detail": "Given token not valid for any token type",
"code": "token_not_valid",
"messages": [
{
"token_class": "AccessToken",
"token_type": "access",
"message": "Token is invalid or expired"
}
]
}
404 Not Found

No provider found with this ID

{
"detail": "Not found"
}