---
title: "Buckyput"
url: "https://developer-qual.migros.ch/apis/buckyput-1/versions/9a8f669f-ef64-4b7d-966d-153612b20270"
---

# Buckyput

OpenAPI specification document.

```json
{"components":{"parameters":{"content_dispo":{"description":"An optional header used to define the file name. Only the filname is used, the media type is ignored.\n\nNote: The use if this header is uncommon and included for backward compatibility only. If you are tempted to use it, you might want to consider switching to the \"Upload File\" route.","in":"header","name":"Content-Disposition","required":false,"schema":{"title":"Content-Disposition","type":"string"}},"file_prefix":{"description":"The prefix of the autogenerated file name. It will be ignored if the file name is defined in the Content-Disposition header.","in":"query","name":"file_prefix","required":false,"schema":{"type":"string"}},"file_suffix":{"description":"The suffix of the autogenerated file name. It will be ignored if the file name is defined in the Content-Disposition header.","in":"query","name":"file_suffix","required":false,"schema":{"type":"string"}},"folder":{"description":"The folder name inside the bucket, where the files will be stored","in":"query","name":"folder","required":false,"schema":{"type":"string"}}},"responses":{"BadRequestResponse":{"description":"The request body had invalid format (file validation failed) or was missing required parameters."},"CreatedResponse":{"description":"Upload was successful.","headers":{"X-Created-File":{"description":"Base file name under which data was saved.","schema":{"type":"string"}},"X-Created-Path":{"description":"Full path under which data was saved.","schema":{"type":"string"}}}},"DefaultResponse":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Standard HTTP semantics; no machine-interpretable body."},"InternalServerError":{"description":"There was a serverside error on your request."},"OkayResponse":{"description":"Request was successful"}},"securitySchemes":{"Basic-Auth":{"description":"Kong basic-auth authentication","scheme":"basic","type":"http"},"Kong-Api-Key":{"description":"Kong key-auth authentication","in":"header","name":"X-Api-Key","type":"apiKey"}}},"info":{"contact":{"email":"arg_mgb-udp-business-services@mgb.ch","name":"MGB-UDP-Business-Services"},"description":"Buckyput is used to upload data files to Buckets from where they can be ingested into the M-ADP plattfrom for further analysis.","title":"Buckyput","version":"1.1.0-beta.1"},"openapi":"3.0.1","paths":{"/migros/enterprise-support/adp-upload/v1/file":{"post":{"description":"Route for uploading file data to the desired folder of a bucket.","operationId":"upload_file","parameters":[{"$ref":"#/components/parameters/folder"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"format":"binary","type":"string"}},"type":"object"}}},"description":"File to upload."},"responses":{"201":{"$ref":"#/components/responses/CreatedResponse"},"default":{"$ref":"#/components/responses/DefaultResponse"}},"security":[{"Basic-Auth":[]}],"summary":"Upload File","tags":["Upload"]}},"/migros/enterprise-support/adp-upload/v1/raw":{"post":{"description":"Route for uploading raw data to the desired folder of a bucket.\n\nThe POST body is saved as a file to the bucket. The path to the file is determined by the `folder` parameter with a Year/Month/Day component added. The actual filename is created from the current time HourMinuteSecond augmented by optional pre- and suffix.","operationId":"upload_raw","parameters":[{"$ref":"#/components/parameters/folder"},{"$ref":"#/components/parameters/file_prefix"},{"$ref":"#/components/parameters/file_suffix"},{"$ref":"#/components/parameters/content_dispo"}],"requestBody":{"content":{"application/json":{"schema":{"format":"binary","type":"string"}},"application/vnd.ms-excel":{"schema":{"format":"binary","type":"string"}},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"format":"binary","type":"string"}},"application/xml":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"format":"binary","type":"string"}},"text/plain":{"schema":{"format":"binary","type":"string"}}},"description":"Data to upload."},"responses":{"201":{"$ref":"#/components/responses/CreatedResponse"},"default":{"$ref":"#/components/responses/DefaultResponse"}},"security":[{"Basic-Auth":[]}],"summary":"Upload Raw","tags":["Upload"]}},"/migros/enterprise-support/adp-upload/v1/upload":{"get":{"description":"Route for returning the upload UI that will later send checked/verified files into the bucket.","operationId":"serve_upload_page","responses":{"200":{"$ref":"#/components/responses/OkayResponse"},"default":{"$ref":"#/components/responses/DefaultResponse"}},"security":[{"Basic-Auth":[]}],"summary":"Returns the upload.html page for File Validation/Uploads","tags":["GUI"],"x-kong-plugin-acl":{"config":{"allow":["buckyput-gui"]}}},"post":{"description":"Route for validating the file uploaded via the UI and uploading it to the desired folder if the option was selected and validation was successful.","operationId":"validate_file","parameters":[{"$ref":"#/components/parameters/folder"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"format":"binary","type":"string"},"validate_upload":{"type":"string"}},"type":"object"}}},"description":"File to validate/upload."},"responses":{"200":{"$ref":"#/components/responses/OkayResponse"},"201":{"$ref":"#/components/responses/CreatedResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"500":{"$ref":"#/components/responses/InternalServerError"},"default":{"$ref":"#/components/responses/DefaultResponse"}},"security":[{"Basic-Auth":[]}],"summary":"Validate/Upload File","tags":["GUI"],"x-kong-plugin-acl":{"config":{"allow":["buckyput-gui"]}}}}},"security":[{"Basic-Auth":[]},{"Kong-Api-Key":[]}],"servers":[{"description":"URL of upstream","url":"https://api-qual.migros.ch"}],"tags":[{"name":"Upload"},{"name":"GUI"}],"x-company":"migros","x-edm-domain":"enterprise-support","x-headmatter":{"readable_by":"*"},"x-kong-route-defaults":{"protocols":["https"],"strip_path":false},"x-kong-service-defaults":{"connect_timeout":500,"read_timeout":5000,"retries":1,"write_timeout":5000},"x-leanix-id":"6728f959-ffe6-44f3-b671-4dfaf221d669","x-link-get-access":"https://forms.office.com/e/zhzbEqAQ26","x-link-get-support":"mailto:9961fcb6.migros.onmicrosoft.com@ch.teams.ms"}
```