endpoints

Creates, updates, deletes, gets or lists an endpoints resource.

Overview

Name	endpoints
Type	Resource
Id	snowflake.service.endpoints

Fields

The following fields are returned by SELECT queries:

show_service_endpoints

successful

Name	Datatype	Description
name	string	User-friendly endpoint name that represents the corresponding port.
ingress_url	string	Endpoint URL accessible from the internet.
is_public	boolean	True, if the endpoint is public, accessible from internet.
port	integer	The network port the service is listening on. NULL, when portRange is specified.
portRange	string	The network port range the service is listening on. NULL, when port is specified.
protocol	string	Supported network protocol (TCP, HTTP, or HTTPS). (default: HTTP)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
show_service_endpoints	select	database_name, schema_name, name, endpoint		Lists the endpoints in a Snowpark Container Services service (or a job service).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
database_name	string	Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases.
endpoint	string	Organization and Account Name (default: orgid-acctid)
name	string	Identifier (i.e. name) for the resource.
schema_name	string	Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database.

SELECT examples

show_service_endpoints

Lists the endpoints in a Snowpark Container Services service (or a job service).

SELECT
name,
ingress_url,
is_public,
port,
portRange,
protocol
FROM snowflake.service.endpoints
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required;