---
title: "Rename file from portal"
method: POST
path: "/api/portals/{portalId}/files/rename"
tags: ["UploadPortal"]
---

# Rename file from portal

`POST /api/portals/{portalId}/files/rename`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/portals/{portalId}/files/rename`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/portals/:portalId/files/rename/post.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `portalId` integer, required

## Request body

- RenamePortalFileRequest
  - `oldPath` string, required: S3 path (within the portal)
  - `newPath` string, required: S3 path (within the portal)

## Response `200`

OK

- GenericApiResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)