• Document Up to Date

AWS S3 Upload (deprecated)

Upload a file to AWS S3.

Note

Make sure that the aws profile id to be used has been configured.

Important

This API is deprecated and provided only as a reference. Please see https://app.swaggerhub.com/apis/craftercms/studio/4.0.2.0#/aws/uploadItem for the current version.

Resource Information

This service uses the tomcat application on port 8080 by default. To see a list of default ports click here

The context for this API is /studio, please prefix the API URLs with this context.

HTTP Verb
POST
URL
/api/1/services/api/1/aws/s3/upload.json
Response Formats
JSON
Required Role
N/A

Parameters

Name
Type
Required
Description
site_id
String
Site to use
profile
String
Profile Id to use

Example

Request

POST .../api/1/services/api/1/aws/s3/upload.json?site_id=mysite&profile=s3-default

Note

This request needs to be sent with Content-Type=multipart/form-data and the file as parameter file.

Response

Status 200 OK

{"bucket":"mybucket456","key":"16229575007_dcf9c870e3_o.jpg"}

Responses

Status
Location
Response Body
200

See example above.
400

{ "message" : "Bad request" }
500

{ "message" : "Internal server error" }