Skip to main content
GET
Discover

Authorizations

Authorization
string
header
required

Bearer API Key. For example, "Bearer {Tenant API Key}"

Headers

Authorization
string
required

Bearer API Key. For example, "Bearer {Tenant API Key}"

Accept
enum<string>

application/json (the default) or application/yaml

Available options:
application/json,
application/yaml

Response

The API reference limited to the calling key

An OpenAPI 3.1 document. Only the fields Plerion adds are described here; the rest is standard OpenAPI.

openapi
string
Example:

"3.1.0"

info
object

The reference's metadata. Its description opens with the role the document was built for.

paths
object

Only the operations the key's role can call. Each operation may carry x-plerion-actions, the permissions any one of which authorizes the call, and x-plerion-integration-scope, either * for every integration in the tenant or an object naming the integrationIds and integrationGroupIds the role covers.

x-plerion-role
object

The role the document was built for.

x-plerion-action-map
string

Hash of the action map the document was derived from, the same map the authorizer enforces.

x-plerion-reference
object

Where the base reference came from.

x-plerion-generated-at
string<date-time>