Read image

GET

/images/{filename}

Last modified:2026-10-03 17:35:06

OperationId:ReadImage

Returns the details of one stored image: who it applies to, its media type and size, and a link that downloads the file. The response is JSON. The image file itself is not in it; download it from file-access-url.

Requires Super User, Super User Read Only, or Reseller scope. A Super User and a Super User Read Only can read every image. A Reseller can read images stored for its own reseller or for a domain in it, and images that apply to every reseller. Other scopes get 403.

An image is stored per reseller, domain, and server, and each defaults to *, meaning all. The values are matched exactly: an image stored for every domain is not found when you name one domain. Name the reseller, domain, and server in the query string to read a copy stored for them.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200OK

application/json

The image's details. Download the file from file-access-url.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/images/logo.png?reseller=example-reseller&domain=*&server=*' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Reseller logo

{
    "reseller": "example-reseller",
    "domain": "*",
    "server": "*",
    "description": "Portal login logo",
    "file-mime-type": "image/png",
    "file-size-bytes": 18342,
    "file-access-url": "https://core1.example.com/ns-api?object=image&action=read&filename=logo.png&server=%2A&territory=example-reseller&domain=%2A"
}

Modified at 2026-10-03 17:35:06

Delete configuration definition

Delete image