Skip to main content

Interface: IEndpointSpec

nexus.v1.IEndpointSpec

Properties of an EndpointSpec.

Implemented by

Properties

description

Optional description: null | string

The markdown description of the endpoint - optional.


name

Optional name: null | string

The name of the endpoint. Must be unique within an account. The name must match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$. This field is mutable.


policySpecs

Optional policySpecs: null | IEndpointPolicySpec[]

The set of policies (e.g. authorization) for the endpoint. Each request's caller must match with at least one of the specs to be accepted by the endpoint. This field is mutable.


targetSpec

Optional targetSpec: null | IEndpointTargetSpec

Indicates where the endpoint should forward received nexus requests to.