Skip to main content
Version: v1

List of S3 Providers

This method is intended to view the list of S3 providers for which CDN connection is available for S3 buckets.

Request Parameters

GET /api/clients/v1/s3Providers/

Headers

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

Query

ParameterTypeConstraintsDescriptionExample
limitinteger> 0Number of objects in the response50
offsetstring> 0Offset from the beginning of the list0

Response Parameters

JSON body

ParameterTypeDescription
countintegerTotal number of providers
nextstringLink to the next page
previousstringLink to the previous page
resultsobject[]List of providers

Examples

200 OK

List of available providers

{
"count": 2,
"next": "http://testserver/api/clients/v1/s3Providers?limit=50&offset=50",
"previous": null,
"results": [
{
"id": 1,
"name": "aws",
"bucket_naming_rule_description": "bucket.s3-hostname.com"
},
{
"id": 2,
"name": "google",
"bucket_naming_rule_description": "s3-hostname.com/bucket"
}
]
}
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"
}
]
}