@Generated public interface ServingEndpointsService
You can use a serving endpoint to serve models from the Databricks Model Registry or from Unity Catalog. Endpoints expose the underlying models as scalable REST API endpoints using serverless compute. This means the endpoints and associated compute resources are fully managed by Databricks and will not appear in your cloud account. A serving endpoint can consist of one or more MLflow models from the Databricks Model Registry, called served entities. A serving endpoint can have at most ten served entities. You can configure traffic settings to define how requests should be routed to your served entities behind an endpoint. Additionally, you can configure the scale of resources that should be applied to each served entity.
This is the high-level interface, that contains generated methods.
Evolving: this interface is under development. Method signatures may change.
| Modifier and Type | Method and Description |
|---|---|
BuildLogsResponse |
buildLogs(BuildLogsRequest buildLogsRequest)
Retrieves the build logs associated with the provided served model.
|
ServingEndpointDetailed |
create(CreateServingEndpoint createServingEndpoint)
Create a new serving endpoint.
|
ServingEndpointDetailed |
createProvisionedThroughputEndpoint(CreatePtEndpointRequest createPtEndpointRequest)
Create a new PT serving endpoint.
|
void |
delete(DeleteServingEndpointRequest deleteServingEndpointRequest)
Delete a serving endpoint.
|
ExportMetricsResponse |
exportMetrics(ExportMetricsRequest exportMetricsRequest)
Retrieves the metrics associated with the provided serving endpoint in either Prometheus or
OpenMetrics exposition format.
|
ServingEndpointDetailed |
get(GetServingEndpointRequest getServingEndpointRequest)
Retrieves the details for a single serving endpoint.
|
GetOpenApiResponse |
getOpenApi(GetOpenApiRequest getOpenApiRequest)
Get the query schema of the serving endpoint in OpenAPI format.
|
GetServingEndpointPermissionLevelsResponse |
getPermissionLevels(GetServingEndpointPermissionLevelsRequest getServingEndpointPermissionLevelsRequest)
Gets the permission levels that a user can have on an object.
|
ServingEndpointPermissions |
getPermissions(GetServingEndpointPermissionsRequest getServingEndpointPermissionsRequest)
Gets the permissions of a serving endpoint.
|
HttpRequestResponse |
httpRequest(ExternalFunctionRequest externalFunctionRequest)
Make external services call using the credentials stored in UC Connection.
|
ListEndpointsResponse |
list()
Get all serving endpoints.
|
ServerLogsResponse |
logs(LogsRequest logsRequest)
Retrieves the service logs associated with the provided served model.
|
EndpointTags |
patch(PatchServingEndpointTags patchServingEndpointTags)
Used to batch add and delete tags from a serving endpoint with a single API call.
|
PutResponse |
put(PutRequest putRequest)
Deprecated: Please use AI Gateway to manage rate limits instead.
|
PutAiGatewayResponse |
putAiGateway(PutAiGatewayRequest putAiGatewayRequest)
Used to update the AI Gateway of a serving endpoint.
|
QueryEndpointResponse |
query(QueryEndpointInput queryEndpointInput)
Query a serving endpoint
|
ServingEndpointPermissions |
setPermissions(ServingEndpointPermissionsRequest servingEndpointPermissionsRequest)
Sets permissions on an object, replacing existing permissions if they exist.
|
ServingEndpointDetailed |
updateConfig(EndpointCoreConfigInput endpointCoreConfigInput)
Updates any combination of the serving endpoint's served entities, the compute configuration of
those served entities, and the endpoint's traffic config.
|
UpdateInferenceEndpointNotificationsResponse |
updateNotifications(UpdateInferenceEndpointNotifications updateInferenceEndpointNotifications)
Updates the email and webhook notification settings for an endpoint.
|
ServingEndpointPermissions |
updatePermissions(ServingEndpointPermissionsRequest servingEndpointPermissionsRequest)
Updates the permissions on a serving endpoint.
|
ServingEndpointDetailed |
updateProvisionedThroughputEndpointConfig(UpdateProvisionedThroughputEndpointConfigRequest updateProvisionedThroughputEndpointConfigRequest)
Updates any combination of the pt endpoint's served entities, the compute configuration of
those served entities, and the endpoint's traffic config.
|
BuildLogsResponse buildLogs(BuildLogsRequest buildLogsRequest)
ServingEndpointDetailed create(CreateServingEndpoint createServingEndpoint)
ServingEndpointDetailed createProvisionedThroughputEndpoint(CreatePtEndpointRequest createPtEndpointRequest)
void delete(DeleteServingEndpointRequest deleteServingEndpointRequest)
ExportMetricsResponse exportMetrics(ExportMetricsRequest exportMetricsRequest)
ServingEndpointDetailed get(GetServingEndpointRequest getServingEndpointRequest)
GetOpenApiResponse getOpenApi(GetOpenApiRequest getOpenApiRequest)
GetServingEndpointPermissionLevelsResponse getPermissionLevels(GetServingEndpointPermissionLevelsRequest getServingEndpointPermissionLevelsRequest)
ServingEndpointPermissions getPermissions(GetServingEndpointPermissionsRequest getServingEndpointPermissionsRequest)
HttpRequestResponse httpRequest(ExternalFunctionRequest externalFunctionRequest)
ListEndpointsResponse list()
ServerLogsResponse logs(LogsRequest logsRequest)
EndpointTags patch(PatchServingEndpointTags patchServingEndpointTags)
PutResponse put(PutRequest putRequest)
PutAiGatewayResponse putAiGateway(PutAiGatewayRequest putAiGatewayRequest)
QueryEndpointResponse query(QueryEndpointInput queryEndpointInput)
ServingEndpointPermissions setPermissions(ServingEndpointPermissionsRequest servingEndpointPermissionsRequest)
ServingEndpointDetailed updateConfig(EndpointCoreConfigInput endpointCoreConfigInput)
UpdateInferenceEndpointNotificationsResponse updateNotifications(UpdateInferenceEndpointNotifications updateInferenceEndpointNotifications)
ServingEndpointPermissions updatePermissions(ServingEndpointPermissionsRequest servingEndpointPermissionsRequest)
ServingEndpointDetailed updateProvisionedThroughputEndpointConfig(UpdateProvisionedThroughputEndpointConfigRequest updateProvisionedThroughputEndpointConfigRequest)
Copyright © 2026. All rights reserved.