This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Media

List public media images for the tenant

get
/api/{tenantId}/admin/media/images

Returns every image stored directly under public/, with its publicly accessible URL.

Authorization

Requires tenant.configuration.media:read scope.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Responses
200

Media images returned.

A public media image, as returned by the list/upload endpoints.

fileNamestringRequired

File name of the image, without any folder segment.

urlstringRequired

Publicly accessible URL of the image.

lastModifiedstring · nullableOptional

Date and time the image was last uploaded, when known.

get/api/{tenantId}/admin/media/images
GET /api/{tenantId}/admin/media/images HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Media images returned.

[
  {
    "fileName": "text",
    "url": "text",
    "lastModified": null
  }
]

Upload a public media image

post
/api/{tenantId}/admin/media/images

Stores the uploaded file under public/{fileName}, using the file's own name. If an image with the same name already exists, it is replaced.

Authorization

Requires tenant.configuration.media:write scope.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired

Identifier of the tenant.

Body
filestring · binaryOptional

Image file to upload (multipart/form-data).

Responses
200

Media image uploaded.

A public media image, as returned by the list/upload endpoints.

fileNamestringRequired

File name of the image, without any folder segment.

urlstringRequired

Publicly accessible URL of the image.

lastModifiedstring · nullableOptional

Date and time the image was last uploaded, when known.

post/api/{tenantId}/admin/media/images
POST /api/{tenantId}/admin/media/images HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{
  "fileName": "text",
  "url": "text",
  "lastModified": null
}

Delete a public media image

delete
/api/{tenantId}/admin/media/images/{fileName}

Removes the image from public/.

Authorization

Requires tenant.configuration.media:write scope.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
fileNamestringRequired
Responses
204

Media image deleted.

No content

delete/api/{tenantId}/admin/media/images/{fileName}
DELETE /api/{tenantId}/admin/media/images/{fileName} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Last updated