Skip to content
Hayonix

API reference · Dedicated endpoints

Delete a deployment that carries no traffic; its replicas are removed

DELETE/v1/endpoint-deployments/{deployment_id}
API keydedicated_endpoint:updateProject
TypeScript
client.dedicatedEndpoints.deleteDeployment()
Python
client.dedicated_endpoints.delete_deployment()
CLI
hayonix endpoints deployments delete

Refused with a conflict while the deployment has a traffic weight above 0: move its share to another deployment with the traffic split first. Its replicas are drained and removed.

Project API key (Authorization: Bearer sk_…), or a console session. Requires the dedicated_endpoint:update permission (a key's scope, or a role that includes it).

Examples

The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.

curl -sS -X DELETE "$API_BASE_URL/endpoint-deployments/dpl_01jc5zq4m8k3v6x9t2w7r0b1e4" \
  -H "Authorization: Bearer $API_KEY"

Request

Headers
HeaderRequiredDescription
AuthorizationyesBearer and your API key. The key implies its project.
X-Project-Idsession onlyThe project to act in, for console sessions. Requests with an API key leave it out.

Path parameters

  • deployment_idstringrequired

    ID of the deployment

    ID with prefix dpl_

Response

200 JSON — Deleted

  • idstringrequired

    ID of the deleted resource

  • objectstringrequired

    Always `endpoint_deployment`

    One ofendpoint_deployment

  • deletedbooleanrequired

    Always true: the resource is deleted

    One oftrue

Example response
Example response
{
  "id": "string",
  "object": "endpoint_deployment",
  "deleted": true
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
404not_found_errorNo such resource in this project (an ID from another project is answered the same way).
409conflict_errorThe resource's current state does not allow this.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.