Get a file CDN

Get a file CDN.

get

Path parameters

idstringRequired

The id of the file cdn.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/cdn/{id}

HTTPcURLJavaScriptPython

GET /api/v1/cdn/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "user": {
      "id": "Plamxinzg18snza",
      "code": "EXAMPLE",
      "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
      "packageId": "1Plamxinzg18snza",
      "packageCode": "PACKAGE",
      "emailAddress": "[e-mail]",
      "phoneNumber": "[phone]",
      "nickName": "example",
      "roles": [
        "admin",
        "support"
      ]
    },
    "refObject": "Object",
    "refId": 1,
    "mimeType": "image/png",
    "fileURL": "https://cdn.jframework.io/uploads/documents/example.pdf",
    "originalFilename": "image.png",
    "fileSize": 1028,
    "notes": "Notes",
    "tags": "Tags",
    "zOrder": 1,
    "isSystem": false,
    "createdDate": "2026-01-26T08:03:23.708498+07:00"
  },
  "errors": []
}