Image

Retrieves a Image resource.

GET/api/images/{id}

Retrieves a Image resource.

curl --request GET \
  --url 'https://app.output.rocks/api/images/string' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

{
  "id": 12345,
  "identifier": "key1",
  "public": false,
  "image": "data:image/png;base64,iVBORw0KGgo...",
  "createdBy": "user1@company.com",
  "updatedBy": "user1@company.com",
  "createdAt": "2024-08-23T00:00:00+00:00",
  "updatedAt": "2024-08-23T00:00:00+00:00",
  "active": true,
  "activeFrom": "2024-01-01"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

stringrequired

Image identifier

Response

200application/json

Image resource

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"