Skip to main content
Version: v1

View Resource

This method retrieves details of an S3 resource

Request Parameters

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

Headers

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

Path

ParameterTypeConstraintsDescriptionExample
idinteger> 0, requiredResource ID16

Response Parameters

JSON body

ParameterTypeDescription
idintegerResource ID
project_idintegerProject ID associated with the resource
namestringResource name
provider_idintegerS3 provider ID
provider_protostringURL scheme (http / https)
provider_hoststringResource hostname
provider_portintegerResource port
cdn_s3_domainstringCDN domain name for the resource
is_activebooleanCDN status for the resource

Examples

200 OK

Resource object

{
"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
}
400 Bad Request

Invalid path parameters specified

{
"id": [
"A valid integer 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 project participants can view resources associated with the project

{
"detail": "Only project participants can view this project's resources"
}
404 Not Found

Resource with specified ID not found

{
"detail": "Resource not found"
}