Service

Delete a service

Changed on Jan 24, 2025

Delete a service by id. Requires admin access.

delete/services/{id}

Request

Base URL
https://demo.ziti.dev/edge/client/v1
Auth
- API key in header zt-session
- or OAuth 2
  Authorization code/oidc/authorize
  Token URL/oidc/token
  Scopesopenid
TypeScript
https://skmtc.dev/openziti/apis/ziti-edge-client/docs/services/:id/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The id of the requested resource

Response

The delete request was successful and the resource has been removed

dataobject required

Example response

{
  "data": {},
  "meta": {
    "apiEnrollmentVersion": "apiEnrollmentVersion",
    "apiVersion": "apiVersion",
    "filterableFields": [
      "filterableFields",
      "filterableFields"
    ],
    "pagination": {
      "limit": 0.8008281904610115,
      "offset": 6.027456183070403,
      "totalCount": 1.4658129805029452
    }
  }
}

Changes

Jan 24, 202519dfd92f02a2 Revision changes
- info
  added the non-success response with the status
- info
  added the non-success response with the status
May 29, 2024cce2800c1357 Revision changes
- warning
  the optional response header WWW-Authenticate removed for the status 200
- warning
  the optional response header WWW-Authenticate removed for the status 400
- warning
  the optional response header WWW-Authenticate removed for the status 401
- warning
  the optional response header WWW-Authenticate removed for the status 409
- warning
  the optional response header WWW-Authenticate removed for the status 429
- info
  removed the non-success response with the status
- info
  removed the non-success response with the status

Operation history