Skip to content

Change an endpoint

PATCH
/v1/api-endpoints/{id}
curl --request PATCH \
--url https://beta-api.plune.ai/v1/api-endpoints/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "trust": "derived", "seen": { "environment": "beta" } }'

The method and the path (it keeps its id, cases and history; one the API has under another endpoint is 409 endpoint_exists), the trust, the summary (null takes it off), the auth (null: not known), or a seen mark on an environment. A summary or an auth describes the endpoint (inSpec), as a spec does. An agent (a write token sending X-Plune-Session) only marks an endpoint seen: a body with method, path, trust, summary or auth is refused (403 agent_proposes) and the endpoint stays as it was - where it is, how far it is trusted and how it is described are a person’s word, or a written spec’s.

id
required
string

The endpoint’s id

Media type application/json
object
method

Moves the endpoint: it keeps its id, cases and history

string
Allowed values: GET PUT POST DELETE OPTIONS HEAD PATCH TRACE
path

Moves the endpoint, as method; a template, as on a POST

string
trust
string
Allowed values: confirmed derived
summary
string
nullable >= 1 characters <= 500 characters
auth

The auth scheme names it asks for, as a spec names them; [] is public

Array<string>
nullable <= 10 items
seen

Mark it seen on an environment - now, or at at; a time ahead of the server is taken as now

object
environment
required

The environment, by its name

string
>= 1 characters <= 100 characters
at
string format: date-time
Example
{
"trust": "derived",
"seen": {
"environment": "beta"
}
}

The endpoint as it is now

Media type application/json
object
id
required
string
projectId
required
string
apiId
required

The API it belongs to (#2398); one endpoint a method and path shape within an API

string
method
required
string
Allowed values: GET PUT POST DELETE OPTIONS HEAD PATCH TRACE
path
required

A template, /orders/{orderId}; one endpoint a method and path shape, whatever its parameters are called

string
source
required

Where the catalog learnt of it; a description replaces traffic once one names it

string
Allowed values: spec code traffic manual
trust
required

derived - inferred from examples or traffic (x-cairn-derived); confirmed - a written spec or a person says so

string
Allowed values: confirmed derived
inSpec
required

A spec, the code or a person describes it - not only traffic. The drift tells its two sides apart by it

boolean
summary
required
string
nullable
auth
required

The auth scheme names it asks for; [] public, null not known

Array<string>
nullable <= 10 items
lastSeenAt
required

When traffic last showed it

string format: date-time
nullable
lastSeenEnvironment
required

Where traffic last showed it

string
nullable
createdBy
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
coverage
required
object
cases
required

The live cases linked to it, each with its external keys - the tests that run it

Array<object>
object
id
required
string
title
required
string
externalKeys
required
Array<object>

An identifier another tool already uses for this test, so a report can find its case without anyone typing a Plune id. The order of kind is load-bearing: it is the ranking that decides which key wins when several match different cases.

object
kind
required
string
Allowed values: playwright-id path-title allure-history cairn-stable eval-id qase testrail testomat zephyr
value
required
string
<= 1024 characters
Example
{
"id": "6f1c2b3a-0000-4000-8000-000000002192",
"projectId": "u-shop::default",
"apiId": "4b6f3c1e-8d2a-4f5b-9c7e-1a2b3c4d5e6f",
"method": "GET",
"path": "/orders/{orderId}",
"source": "spec",
"trust": "derived",
"inSpec": true,
"summary": "One order",
"auth": [
"bearerAuth"
],
"lastSeenAt": "2026-11-03T10:00:00.000Z",
"lastSeenEnvironment": "beta",
"createdBy": "6f1c2b3a-0000-4000-8000-0000000000a2",
"createdAt": "2026-11-04T09:00:00.000Z",
"updatedAt": "2026-11-04T09:05:00.000Z",
"coverage": {
"cases": []
}
}

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 changing the method, path, trust, summary or auth (agent_proposes)

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

No such endpoint in your project

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

The API has this method and path under another endpoint (endpoint_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"
}
Retry-After
integer

Seconds until the window rolls over