Rename library

Edit online

Sets the user-defined name of the library. This library name is used to identify the library in the REST API, GUI, and CLI. It is not communicated to the host.

Request syntax

PATCH /v1/library {"name":<new name>}
Sets the user-defined name of the library.

Request body parameters

name (string, optional): The new name for the library. This name is restricted to a length of 15 characters.

Example

> PATCH /v1/library {"name": "myLib1"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0

Error handling

Returns 400 Bad Request if name length is greater than 15 characters or less than one character.
Returns 400 Bad Request if name contains anything other than alphanumeric or underscore, _, characters.