Jump to

• Request
• Response

Modify an Image

put

/storage/v1/Images

Request

Supported Media Types

• multipart/form-data

Body ()

Root Schema : schema

Type: object

Show Source

• deleteAfter(optional): integer
  Amount of seconds for the image to be deleted.
• file: string
  Binary image content.
• fileName: string
  Name of the image to update. May include path.

  Example: images/image1.png

{
    "type":"object",
    "properties":{
        "fileName":{
            "description":"Name of the image to update. May include path.",
            "type":"string",
            "example":"images/image1.png"
        },
        "file":{
            "description":"Binary image content.",
            "type":"string"
        },
        "deleteAfter":{
            "description":"Amount of seconds for the image to be deleted.",
            "type":"integer"
        }
    },
    "required":[
        "fileName",
        "file"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Image update status details.

Body ()

Root Schema : ImagesResponse

Type: object

Result of the file upload

Show Source

• fileName: string
  Name of the created file.
• fileUrl(optional): string
  Link to access the public file.
• isPublic(optional): boolean
  Indicates whether the file is public or private. Files uploaded using the Images endpoint are public.

{
    "description":"Result of the file upload",
    "type":"object",
    "properties":{
        "fileName":{
            "type":"string",
            "description":"Name of the created file."
        },
        "isPublic":{
            "type":"boolean",
            "description":"Indicates whether the file is public or private. Files uploaded using the Images endpoint are public."
        },
        "fileUrl":{
            "type":"string",
            "description":"Link to access the public file."
        }
    },
    "required":[
        "fileName"
    ]
}

Back to Top