Jump to

• Request
• Response

Create a File

post

/storage/v1/Files

Request

Supported Media Types

• multipart/form-data

Body ()

Root Schema : schema

Type: object

Show Source

• contentType: string
  HTTP content type of the uploaded file.
• deleteAfter(optional): integer
  Amount of seconds after which the file will be deleted.
• file: string
  Binary file content.
• fileName: string
  Name of the file to create. May include path.

  Example: filepath/file1.txt
• filePartName(optional): string
  Name of the file part. Used when the file is in multiple parts.
• isMultiPartFile(optional): boolean
  Indicates that the file will be made of a collection of files with the same filename, but with different file part names.
• isPublic(optional): boolean
  Indicates whether the file will be private or public. Only private files are supported currently.

  Example: true

{
    "type":"object",
    "properties":{
        "fileName":{
            "description":"Name of the file to create. May include path.",
            "type":"string",
            "example":"filepath/file1.txt"
        },
        "file":{
            "description":"Binary file content.",
            "type":"string"
        },
        "isPublic":{
            "description":"Indicates whether the file will be private or public. Only private files are supported currently.",
            "type":"boolean",
            "example":true
        },
        "contentType":{
            "description":"HTTP content type of the uploaded file.",
            "type":"string"
        },
        "deleteAfter":{
            "description":"Amount of seconds after which the file will be deleted.",
            "type":"integer"
        },
        "isMultiPartFile":{
            "description":"Indicates that the file will be made of a collection of files with the same filename, but with different file part names.",
            "type":"boolean"
        },
        "filePartName":{
            "description":"Name of the file part. Used when the file is in multiple parts.",
            "type":"string"
        }
    },
    "required":[
        "fileName",
        "file",
        "contentType"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

File creation status details.

Body

Example Response (application/json)

{
    "fileName":"files/filepath/file1.txt",
    "isPublic":true,
    "fileUrl":"https://storage.example.com/v1/Storage-ocistest/B027/files/filepath/file1.txt"
}

Back to Top