Skip to main content
PUT
/
dedicated
/
beta
/
endpoint
/
{endpoint_id}
/
sleep
Sleep endpoint
curl --request PUT \
  --url https://api.friendli.ai/dedicated/beta/endpoint/{endpoint_id}/sleep \
  --header 'Authorization: Bearer <token>'
{
  "status": "UNKNOWN",
  "createdAt": "2023-11-07T05:31:56Z",
  "errorCode": "WORKLOAD_INIT_UNKNOWN_ERROR",
  "updatedAt": "2023-11-07T05:31:56Z",
  "phase": "REQUESTING_VIRTUAL_MACHINE"
}
Put a Dedicated Endpoint to sleep mode. To request successfully, it is mandatory to enter a Friendli Token (e.g. flp_XXX) value in the Bearer Token field. Refer to the authentication section on our introduction page to learn how to acquire this variable and visit here to generate your token.
This API is currently in Beta. While we strive to provide a stable and reliable experience, this feature is still under active development. As a result, you may encounter unexpected behavior or limitations. We encourage you to provide feedback to help us improve the feature before its official release.

Authorizations

​
Authorization
string
header
required

When using Friendli Suite API for inference requests, you need to provide a Friendli Token for authentication and authorization purposes.

For more detailed information, please refer here.

Headers

​
X-Friendli-Team
string | null

ID of team to run requests as (optional parameter).

Path Parameters

​
endpoint_id
string
required

The ID of the endpoint

Response

Successfully requested to put the endpoint to sleep.

Dedicated endpoint status.

​
status
enum<string>
required

The current status of the endpoint deployment.

Available options:
UNKNOWN,
INITIALIZING,
RUNNING,
UPDATING,
SLEEPING,
AWAKING,
FAILED,
STOPPING,
TERMINATING,
TERMINATED,
READY
​
createdAt
string<date-time>
required

When the endpoint was created.

​
errorCode
enum<string> | null

Error code if deployment failed.

Available options:
WORKLOAD_INIT_UNKNOWN_ERROR,
WORKLOAD_INIT_SETTINGS_ERROR,
WORKLOAD_INIT_GRPC_ERROR,
WORKLOAD_INIT_MANIFEST_NOT_FOUND_ERROR,
WORKLOAD_INIT_MANIFEST_TYPE_ERROR,
WORKLOAD_INIT_DOWNLOAD_ERROR,
WORKLOAD_INIT_INVALID_TOKEN_ERROR,
WORKLOAD_INIT_CANNOT_ACCESS_REPO_ERROR,
WORKLOAD_INIT_HF_WANDB_API_ERROR,
WORKLOAD_INIT_INSUFFICIENT_DISK_ERROR,
INFERENCE_ENGINE_UNKNOWN_ERROR,
INFERENCE_ENGINE_INVALID_ARGUMENT_ERROR,
INFERENCE_ENGINE_MEMORY_ERROR,
INFERENCE_ENGINE_METERING_CLIENT_CONFIG_ERROR
​
updatedAt
string<date-time> | null

When the endpoint was last updated.

​
phase
enum<string> | null

The current phase of the endpoint.

Available options:
REQUESTING_VIRTUAL_MACHINE,
DOWNLOADING_MODEL,
ENGINE_INITIALIZING