Rename an API
PATCH
/v1/apis/{id}
const url = 'https://beta-api.plune.ai/v1/apis/example';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"Shop API v2"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://beta-api.plune.ai/v1/apis/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "Shop API v2" }'A person; an agent is refused (403 agent_proposes). A name the project has under another API is 409 api_exists.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
The API’s id
Request Body required
Section titled “Request Body required ” Media type application/json
object
name
required
string
Example
{ "name": "Shop API v2"}Responses
Section titled “ Responses ”The API as it is now
Media type application/json
An API of the project’s catalog (#2398): catalog, API, endpoints.
object
id
required
string
projectId
required
string
name
required
The project’s once, whatever its case
string
endpoints
required
How many endpoints it holds
integer
createdBy
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{ "id": "4b6f3c1e-8d2a-4f5b-9c7e-1a2b3c4d5e6f", "projectId": "u-shop::default", "name": "Shop API v2", "endpoints": 1, "createdBy": "6f1c2b3a-0000-4000-8000-0000000000a2", "createdAt": "2026-11-04T09:00:00.000Z", "updatedAt": "2026-11-04T09:00:00.000Z"}Invalid JSON or body
Media type application/json
object
error
required
string
Example generated
{ "error": "example"}No / invalid token or session
A reader, a read token, or an agent (agent_proposes)
Media type application/json
object
error
required
string
Example generated
{ "error": "example"}No such API in your project
Media type application/json
object
error
required
string
Example generated
{ "error": "example"}The project has another API of this name (api_exists)
Media type application/json
object
error
required
string
Example generated
{ "error": "example"}Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.
Media type application/json
object
error
required
string
Example generated
{ "error": "example"}Headers
Section titled “Headers ” Retry-After
integer
Seconds until the window rolls over