Resource List
This method retrieves a list of S3 resources associated with a project
Request Parameters
GET /api/clients/v1/s3Resources/
Headers
- Content-Type: application/json
- Authorization: Bearer
$access_token
Query Parameters
| Parameter | Type | Constraints | Description | Example |
|---|---|---|---|---|
| project_id | integer | > 0, required | Project ID associated with the resource | 2 |
| query | string | Resource name filter | europe | |
| limit | integer | > 0 | Number of items per page | 50 |
| offset | string | > 0 | Pagination offset | 0 |
Response Parameters
JSON body
| Parameter | Type | Description |
|---|---|---|
| count | integer | Total number of resources |
| next | string | URL to next page |
| previous | string | URL to previous page |
| results | object[] | List of resources |
Examples
200 OK
List of resources
{
"count": 2,
"next": "http://testserver/api/clients/v1/s3Resources?project_id=2&query=europe&limit=50&offset=50",
"previous": null,
"results": [
{
"id": 16,
"project_id": 2,
"name": "storage-europe",
"provider_id": 1,
"provider_proto": "https",
"provider_host": "storage.googleapis.com",
"provider_port": 443,
"cdn_s3_domain": "s16.s3-clients.cdn.itglobal.com",
"is_active": true
},
{
"id": 33,
"project_id": 2,
"name": "europe-resource-1",
"provider_id": 2,
"provider_proto": "https",
"provider_host": "s3.amazonaws.com",
"provider_port": 443,
"cdn_s3_domain": null,
"is_active": false
}
]
}
400 Bad Request
Invalid or missing required query parameters
{
"project_id": [
"This field is required."
]
}
401 Unauthorized
Authentication credentials 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"
}
]
}
403 Forbidden
Only resources associated with the current user's project are available
{
"detail": "Only project participants can view this project's resources"
}