Endpoints

Update endpoint, this can also be used to start or stop a dedicated endpoint

PATCH
/endpoints/{endpointId}

Updates an existing endpoint's configuration. You can modify the display name, autoscaling settings, or change the endpoint's state (start/stop).

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

endpointId*string

The ID of the endpoint to update

Request Body

application/json

display_name?string

A human-readable name for the endpoint

state?string

The desired state of the endpoint

Value in

  • "STARTED"
  • "STOPPED"
autoscaling?

New autoscaling configuration for the endpoint

inactive_timeout?integer

The number of minutes of inactivity after which the endpoint stops automatically. Set to 0 to disable automatic timeout.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/endpoints/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "object": "endpoint",  "id": "string",  "name": "string",  "display_name": "string",  "model": "string",  "hardware": "string",  "type": "dedicated",  "owner": "string",  "state": "PENDING",  "autoscaling": {    "min_replicas": 2,    "max_replicas": 5  },  "created_at": "2019-08-24T14:15:22Z"}