Skip to main content
POST
Get a knowledge record
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

POST /api/v2/knowledge/records/get reads one record the credential can read, named by its entryId, by its sourceId, kind and externalId, or by its collectionId, kind and externalId. It needs knowledge:read. Supply exactly one address form. The answer is the record and its status: An authored record is always current and returns collectionId plus its positive numeric version. A synchronized record keeps the existing sourceId response. A record that does not exist, or an entryId that names a case, answers 404 resource_missing; read a case with POST /api/v2/knowledge/get. A record the credential may not read, such as one restricted at its source, outside its namespaces or in a collection it is not admitted to, answers the same 404 resource_missing, and nothing is recorded, so a refusal never confirms that a record exists. Naming both forms, or neither, answers 400.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Body

application/json
entryId
string
required
Minimum string length: 1
actingFor
string

The orgUnitId of the one external organization this request acts for (listed by GET /api/v2/knowledge/scopes/list with scopeType organization). It needs knowledge:read (knowledge:manage for an edit) at that organization's own unit or at platform scope; a grant at Gloo's root does not reach it. Absent, the request reads Gloo's knowledge only and never an organization's. One organization per request. A refused actingFor answers 403; an admitted one is audited before the answer, and a read whose audit cannot be written answers 500.

Required string length: 1 - 200

Response

The record and its status

data
object
required

One record and its status: current; quarantined (its last sync of it failed); or stale (its kind's last verification is older than its source allows).

meta
object
required