Image

Creates a Image.

Creates a Image.

POST/api/images

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Request Body

application/json
required

The new Image resource

{
  "identifier": "key1",
  "public": false,
  "image": "data:image/png;base64,iVBORw0KGgo...",
  "active": true,
  "activeFrom": "2024-01-01"
}

Response

201application/json

Image resource created

id
integer

Identifier generated by Output.Rocks.

Example: 12345

identifier
stringrequired

Unique identifier

Example: "key1"

public
boolean

Public flag. Default: false

Available options: truefalse

Example: false

image
string<binary>

base64 encoded image file

Example: "data:image/png;base64,iVBORw0KGgo..."

createdBy
string

User, created this entry

Example: "user1@company.com"

updatedBy
string

User, updated this entry

Example: "user1@company.com"

createdAt
string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt
string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

active
boolean

Active flag. Default: true

Available options: truefalse

Example: true

activeFrom
string<date-time>

Date to activate the entry. Default: today

Example: "2024-01-01"