Skip to content

Latest commit

 

History

History
52 lines (41 loc) · 3.33 KB

File metadata and controls

52 lines (41 loc) · 3.33 KB
title sys.endpoints (Transact-SQL)
description sys.endpoints returns one row per endpoint that is created in the system, including the SYSTEM endpoint.
author rwestMSFT
ms.author randolphwest
ms.date 02/05/2026
ms.service sql
ms.subservice system-objects
ms.topic reference
f1_keywords
endpoints
sys.endpoints
endpoints_TSQL
sys.endpoints_TSQL
helpviewer_keywords
sys.endpoints catalog view
dev_langs
TSQL

sys.endpoints (Transact-SQL)

[!INCLUDE SQL Server]

Returns one row per endpoint created in the system. There's always exactly one SYSTEM endpoint.

Column name Data type Description
name sysname Name of the endpoint. Unique within the server. Not nullable.
endpoint_id int ID of the endpoint. Unique within the server. An endpoint with an ID less than 65536 is a system endpoint. Not nullable.
principal_id int ID of the server principal that created and owns this endpoint. Nullable.
protocol tinyint Endpoint protocol.

1 = HTTP

2 = TCP

3 = Named pipes

4 = Shared memory

5 = Virtual Interface Adapter (VIA)

Not nullable.
protocol_desc nvarchar(60) Description of the endpoint protocol. Nullable. One of the following values:

HTTP

TCP

NAMED_PIPES

SHARED_MEMORY

VIA Note: The VIA protocol is deprecated. [!INCLUDEssNoteDepFutureAvoid]
type tinyint Endpoint payload type.

1 = SOAP

2 = TSQL

3 = SERVICE_BROKER

4 = DATABASE_MIRRORING

Not nullable.
type_desc nvarchar(60) Description of the endpoint payload type. Nullable. One of the following values:

SOAP

TSQL

SERVICE_BROKER

DATABASE_MIRRORING
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. 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.

Nullable.
is_admin_endpoint bit Indicates whether the endpoint is for administrative use.

0 = Nonadministrative endpoint.

1 = Endpoint is an administrative endpoint.

Not nullable.

Permissions

[!INCLUDE ssCatViewPerm] For more information, see Metadata Visibility Configuration.

Permissions for SQL Server 2022 and later

Requires VIEW SERVER SECURITY STATE permission on the server.

Related content