Skip to content

The project’s API catalog

GET
/v1/api-endpoints
curl --request GET \
--url https://beta-api.plune.ai/v1/api-endpoints \
--header 'Authorization: Bearer <token>'

Every endpoint of the project, or of one API (apiId), by path then method, each with how many live cases test it. Anyone in the project.

apiId
string

One API of the project (GET /v1/apis); another project’s, or one that is not there, is 404

The endpoints

Media type application/json
object
endpoints
required

By path, then method

Array<object>
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

How many live cases test it; GET /v1/api-endpoints/{id} names them

integer
health
required

How its live cases stand by their newest results, in a requirement’s words: failing - one failed or broke; passing - all passed; partial - some passed; notRun - none passed; noCases - none

string
Allowed values: failing passing partial notRun noCases
Example
{
"endpoints": [
{
"id": "6f1c2b3a-0000-4000-8000-000000002192",
"projectId": "u-shop::default",
"apiId": "4b6f3c1e-8d2a-4f5b-9c7e-1a2b3c4d5e6f",
"method": "GET",
"path": "/orders/{orderId}",
"source": "spec",
"trust": "confirmed",
"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": 1,
"health": "passing"
}
]
}

No / invalid token or session

No such API in your project

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