---
title: "Update all fields on a service"
method: PUT
path: "/services/{id}"
tags: ["Service"]
---

# Update all fields on a service

`PUT /services/{id}`

## Request

- Base URL: `https://demo.ziti.dev/edge/client/v1`
- URL: `https://demo.ziti.dev/edge/client/v1/services/{id}`
- Auth: one of:
  - API key in header `zt-session`
  - OAuth 2
    - Authorization code: `/oidc/authorize`
    - Token URL: `/oidc/token` scopes: `openid`
- TypeScript: <https://skmtc.dev/openziti/apis/ziti-edge-client/docs/services/:id/put.ts> (a function with typed inputs; its response is checked against the schema)

Update all fields on a service by id. Requires admin access.

## Path parameters

- `id` string, required

## Request body

- ServiceUpdate
  - `configs` string[]
  - `encryptionRequired` boolean: Describes whether connections must support end-to-end encryption on both sides of the connection. Read-only property, set at create.
  - `maxIdleTimeMillis` integer
  - `name` string, required
  - `roleAttributes` string[]
  - `tags` Tags
  - `terminatorStrategy` string

## Response `200`

The update request was successful and the resource has been altered

- Empty
  - `data` object, required
  - `meta` Meta, required
    - `apiEnrollmentVersion` string
    - `apiVersion` string
    - `filterableFields` string[]
    - `pagination` Pagination
      - `limit` number, required
      - `offset` number, required
      - `totalCount` number, required

## Other responses

- `400`: The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information
- `401`: The supplied session does not have the correct access rights to request this resource
- `404`: The requested resource does not exist
- `429`: The resource requested is rate limited and the rate limit has been exceeded
- `503`: The request could not be completed due to the server being busy or in a temporarily bad state

## Changes

- **2026-10-14** `f7b51eaafbbb`: 1 info
  - the request property `tags` became nullable
- **2025-01-24** `19dfd92f02a2`: 1 info
  - added the non-success response with the status `503`
- **2024-05-29** `cce2800c1357`: 5 warning, 1 info
  - the optional response header `WWW-Authenticate` removed for the status `200`
  - the optional response header `WWW-Authenticate` removed for the status `400`
  - the optional response header `WWW-Authenticate` removed for the status `401`
  - the optional response header `WWW-Authenticate` removed for the status `404`
  - …2 more

[Operation history](https://skmtc.dev/openziti/apis/ziti-edge-client/changes/services/:id/put.md)

---

[API](https://skmtc.dev/openziti/apis/ziti-edge-client.md) - [All operations](https://skmtc.dev/openziti/apis/ziti-edge-client/llms.txt) - [OpenAPI document](https://skmtc.dev/openziti/apis/ziti-edge-client/revisions/f7b51eaafbbb?raw)