s3upload API API documentation version v1

https://client-api.magine.com/api/s3upload/{version}

  • version: required (v1)

Form file upload

post

post

Uploads file to specified bucket and path with original name.

Uploads file to specified bucket and path with original name.

URI Parameters

  • bucket: required (string)
  • path: required (string)

HTTP status code 200

Ok

Body

Media type: application/json

Type: object

Properties
  • bucket: required (string)
  • objectKeys: required (array of string)

Example:

{
  "bucket": "com.magine.uploads",
  "objectKeys": [
    "file1.png"
  ]
}

HTTP status code 400

Bad request

Body

Media type: application/json

Type: object

Properties
  • message: required (string)
  • code: required (integer)
  • errors: required (array of object)

    Items:

    Example:

    {
  "message": "something went wrong",
  "code": 400,
  "errors": [
    {
      "detail": "error",
      "exception": "IOException"
    }
  ]
}

    Form file upload

    post

    post

    Uploads file to specified bucket and path with a generated uuid name.

    Uploads file to specified bucket and path with a generated uuid name.

    URI Parameters

    • bucket: required (string)
    • path: required (string)

    HTTP status code 200

    Ok

    Body

    Media type: application/json

    Type: object

    Properties
    • bucket: required (string)
    • objectKeys: required (array of string)

    Example:

    {
  "bucket": "com.magine.uploads",
  "objectKeys": [
    "file1.png"
  ]
}

    HTTP status code 400

    Bad request

    Body

    Media type: application/json

    Type: object

    Properties
    • message: required (string)
    • code: required (integer)
    • errors: required (array of object)

      Items:

      Example:

      {
  "message": "something went wrong",
  "code": 400,
  "errors": [
    {
      "detail": "error",
      "exception": "IOException"
    }
  ]
}

      Assisted upload

      post

      post

      Downloads a resource and uploads it to specified bucket and path.

      Downloads a resource and uploads it to specified bucket and path.

      URI Parameters

      • bucket: required (string)
      • path: required (string)

      Body

      Media type: application/json

      Type: object

      Properties
      • downloadSrc: required (string)
      • fileExtension: required (string)

      Example:

      {
  "downloadSrc": "http://images.com/image.jpg",
  "fileExtension": "jpg"
}

      HTTP status code 200

      Ok

      Body

      Media type: application/json

      Type: object

      Properties
      • bucket: required (string)
      • objectKeys: required (array of string)

      Example:

      {
  "bucket": "com.magine.uploads",
  "objectKeys": [
    "file1.png"
  ]
}

      HTTP status code 400

      Bad request

      Body

      Media type: application/json

      Type: object

      Properties
      • message: required (string)
      • code: required (integer)
      • errors: required (array of object)

        Items:

        Example:

        {
  "message": "something went wrong",
  "code": 400,
  "errors": [
    {
      "detail": "error",
      "exception": "IOException"
    }
  ]
}