Detach an Endpoint

DELETE /v1/applications/{uuid}/endpoints/{endpoint_uuid}

Stops serving the application on one of its endpoints. The endpoint goes back to being a tunnel endpoint of your account, with its hostname and settings, and shows Offline until an agent connects to it. Nothing is deleted: to remove the endpoint for good, delete it instead.

If it was the app's primary, the app's oldest remaining endpoint becomes the primary. If it was the app's only endpoint, the app has no public URL until you attach or create another. Detaching an endpoint from a WordPress app restarts the site so it picks up its address.

Requires the caller's account to have Endpoints write permission and the plan's application hosting. In the dashboard: the endpoint's menu on the app's Domains tab, Detach from app. From a terminal, ngris api applications detach-endpoint is a destructive command: as one command or in a script it needs --yes.

Path parameters

uuid string (uuid) Req
The application.
endpoint_uuid string (uuid) Req
One of the app's endpoints, from endpoints in GET /v1/applications/{uuid}.

Response

204 No Content
Detached. The response body is empty.

Errors

400
The endpoint is named by a number (integer_id_unsupported): use its uuid.
403
Your role lacks Endpoints write, or the plan has no application hosting.
404
application not found, or Endpoint not found: the endpoint isn't one of this app's endpoints.
409
quota_paused: the app is paused over your plan's limits and is read-only until the account has room again.
Request
curl -X DELETE \ "https://api.ngris.com/v1/applications/019be838-d261-7d9b-9499-71995a3a91c6/endpoints/019c0a41-5b2e-7f3a-8c1d-4e6f7a8b9c0d" \ -H "X-API-KEY: <your_api_key>"
Response — 204 No Content
(empty body)
Was this helpful?
On this page
Detach an Endpoint
Was this helpful?