---
title: "Rename device"
method: POST
path: "/api/{projectId}/devices/{deviceId}/rename"
tags: ["Devices"]
---

# Rename device

`POST /api/{projectId}/devices/{deviceId}/rename`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/{projectId}/devices/{deviceId}/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/:projectId/devices/:deviceId/rename/post.ts> (a function with typed inputs; its response is checked against the schema)

Set the current name for a device.

## Path parameters

- `projectId` integer, required
- `deviceId` string, required

## Request body

- RenameDeviceRequest
  - `name` string, required: New name for this device

## 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)