ServiceResource
Update a service
Updates an existing service by ID.
Required API key permissions
- Scope: services:update
- Accepted key types: organization API key (org-wide), personal access token (org-wide)
- Access: Operates on a single organization. Pass organizationId when your API key spans multiple organizations.
- Required organization role (user-linked keys only): Administrator
- Organization API keys are not subject to organization or team role checks.
put/api/public/v1/service/{id}
Request
- Base URLhttps://allquiet.app (the document declares no server; this is the origin it was published from)
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
Query parameters
organizationIdstring uuid
provisionboolean
When true, the created or updated resource is marked as provisioned and becomes read-only in the web UI. Defaults to false on create. On update, omitting this parameter preserves the existing provisioned state. Not available for personal access tokens.
Request body
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.