OSos3robotics
endpoints

Retire Endpoint

desired -> retired; provisioning/warming/healthy -> draining (the driver tears the replica down and retires it); already draining or retired: unchanged, 200. A replica of a desired endpoint, a retired one too, stops that desired endpoint and moves each of its replicas so.

post/endpoints/{endpoint_id}/retire

Request

  • Base URL
    https://api.os3robotics.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.os3robotics.com/endpoints/{endpoint_id}/retire
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

endpoint_idstring uuid required

Response

Successful Response

idstring uuid required
tenant_idstring uuid required
workspace_idstring uuid required
namestring required
endpoint_type'vla_policy' | 'planner_llm' | 'harness' | 'llm_vllm' | 'llm_sglang' required
model_version_idstring uuid nullable required
desired_replicasinteger required
state'desired' | 'provisioning' | 'warming' | 'healthy' | 'draining' | 'retired' required
reasonstring nullable required
tailscale_tagstring required
api_key_refstring required
tls_requiredboolean required
max_sizeinteger required
urlstring nullable required
last_handshakeobject nullable required
healthobject nullable required
launch_requeststring nullable
boxstring nullable
box_slotinteger nullable
dedicated_poolstring nullable
dedicated_slotinteger nullable
poolstring nullable
pool_slotinteger nullable
desired_endpoint_idstring uuid nullable
desired_state'running' | 'stopped' nullable
desired_namestring nullable
last_goodboolean
gpustring nullable
released_adaptersinteger nullable
released_loadedinteger nullable
created_atstring date-time required
state_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.