Skip to main content
GuidesAPI Reference

Administration API Changelog

Every change to the Administration API Suite, newest first. Filter by API for a focused view. Change types follow the API Change Policy.

All APIs
Non-breakingGeneral (suite-wide)v1

Enforced explicit API version headers

The Administration API Suite now enforces explicit API versioning headers on every request. Previously, the Content-Type header was not mandatory on requests with a payload, and a default Accept value of */* was accepted on requests that return a payload.

Consumers must now explicitly declare their required version:

  • Requests with a payload (POST, PUT) must include a versioned Content-Type header.
  • Requests that return a payload (GET, and asynchronous DELETE operations that return an operation) must include a versioned Accept header — a generic Accept: */* is no longer accepted.

Both follow the application/vnd.{resource}.v{major}+json pattern described in API Versioning.

This is a non-breaking change for integrations that already specify a version. It ensures API behavior is deterministic and reduces the impact of future breaking changes by requiring consumers to opt into a specific version rather than an implicit default.

Non-breakingRing Group Managementv1

Targeted ring group membership updates

The Ring Group Management API adds a new endpoint for targeted membership changes: POST /ring-groups/{ringGroupId}/update-members. It applies an atomic add/update/remove delta to a ring group's members in a single request, so you no longer need to read the full ring group and resend the entire member list to add, reorder, or remove members. The request uses the media type application/vnd.ringgroups.update-members.v1+json and returns an operation to poll to completion.

This is a non-breaking addition — existing endpoints are unchanged. See Manage Ring Group Members in the guide for usage, including how sequenceNumber is resolved.

DocsGeneral (suite-wide)v1

Clarified API versioning header guidance

Clarified the API Versioning guidance for the Administration API Suite. The version is carried in the Content-Type header on requests with a payload (POST, PUT) and in the Accept header on requests that return a payload (GET, and asynchronous DELETE operations that return an operation). The synchronous Address DELETE returns no content and is not versioned.

The media type application/vnd.{resource}.v{major}+json is unchanged.