images_image_basic_upload

APIs.ioEngineeringPlatform

Properties

Name Type Description
file object An image binary data. Only needed when type is uploading a file.
metadata object User modifiable key-value store. Can use used for keeping references to another system of record for managing images.
requireSignedURLs boolean Indicates whether the image requires a signature token for the access.
url string A URL to fetch an image from origin. Only needed when type is uploading from a URL.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-images-image-basic-upload-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/images_image_basic_upload",
  "title": "images_image_basic_upload",
  "properties": {
    "file": {
      "description": "An image binary data. Only needed when type is uploading a file.",
      "format": "binary"
    },
    "metadata": {
      "description": "User modifiable key-value store. Can use used for keeping references to another system of record for managing images.",
      "type": "object"
    },
    "requireSignedURLs": {
      "default": false,
      "description": "Indicates whether the image requires a signature token for the access.",
      "example": true,
      "type": "boolean"
    },
    "url": {
      "description": "A URL to fetch an image from origin. Only needed when type is uploading from a URL.",
      "example": "https://example.com/path/to/logo.png",
      "type": "string"
    }
  },
  "type": "object"
}