sys.endpoints (Transact-SQL)

Contains one row per endpoint that is created in the system. There is always exactly one SYSTEM endpoint.

Column Name

Data Type

Description

name

sysname

Name of the endpoint. Is unique within the server. Is not nullable.

endpoint_id

int

ID of the endpoint. Is unique within the server. An endpoint with an ID less then 65536 is a system endpoint. Is not nullable.

principal_id

int

ID of the server principal that created and owns this endpoint. Is nullable.

protocol

tinyint

Endpoint protocol.

1 = HTTP

2 = TCP

3 = Name pipes

4 = Shared memory

5 = Virtual Interface Adapter (VIA)

Is not nullable.

protocol_desc

nvarchar(60)

Description of the endpoint protocol.

  • HTTP

  • TCP

  • NAMED_PIPES

  • SHARED_MEMORY

  • VIA

    Note

    The VIA protocol is deprecated. This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

NULLABLE.

type

tinyint

Endpoint payload type.

1 = SOAP

2 = TSQL

3 = SERVICE_BROKER

4 = DATABASE_MIRRORING

Is not nullable.

type_desc

nvarchar(60)

Description of the endpoint payload type.

  • SOAP

  • TSQL

  • SERVICE_BROKER

  • DATABASE_MIRRORING

Is nullable.

state

tinyint

The endpoint state.

0 = STARTED, listening and processing requests.

1 = STOPPED, listening, but not processing requests.

2 = DISABLED, not listening.

The default state is 1. Is nullable.

state_desc

nvarchar(60)

Description of the endpoint state.

STARTED = Listening and processing requests.

STOPPED = Listening, but not processing requests.

DISABLED = Not listening.

The default state is STOPPED.

Is nullable.

is_admin_endpoint

bit

Indicates whether the endpoint is for administrative use.

0 = Nonadministrative endpoint.

1 = Endpoint is an administrative endpoint.

Is not nullable.

Permissions

The visibility of the metadata in catalog views is limited to securables that a user either owns or on which the user has been granted some permission. For more information, see Metadata Visibility Configuration.

See Also

Reference

Endpoints Catalog Views (Transact-SQL)

Catalog Views (Transact-SQL)