Rename file from portal

Rename file from portal

Rename a file on an upload portal (requires JWT auth).

POSThttps://studio.edgeimpulse.com/v1/api/portals/{portalId}/files/rename

Path parameters

portalId*integer

Portal ID

Body

application/json

oldPath*string

S3 path (within the portal)

newPath*string

S3 path (within the portal)

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/portals/{portalId}/files/rename', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "oldPath": "text",
      "newPath": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text"
}