8x8 Administration - Ring Group Management API

Ring group management API providing endpoints to create, retrieve, list, update, and delete ring groups.

The current version of the API is v1.0.

Authentication

All requests to this API require authentication using an API key. Include your API key in the request header:

x-api-key: YOUR_API_KEY

Versioning

The API version is specified through a vendor-specific media type. Send it in the Content-Type header for requests that carry a payload (such as POST and PUT) and in the Accept header for requests that return a payload (GET, and asynchronous DELETE operations that return an operation resource).

Content-Type: application/vnd.ringgroups.v1+json   # on POST/PUT (request payload)
Accept: application/vnd.ringgroups.v1+json          # on GET (response payload)

Base URL

https://api.8x8.com/admin-provisioning

Endpoints

Endpoint	Method	Purpose	Async?
/ring-groups	GET	Retrieve paginated list of ring groups with filtering	No
/ring-groups	POST	Create a new ring group	Yes
/ring-groups/{ringGroupId}	GET	Retrieve a specific ring group's details	No
/ring-groups/{ringGroupId}	PUT	Update an existing ring group	Yes
/ring-groups/{ringGroupId}	DELETE	Remove a ring group	Yes
/ring-groups/{ringGroupId}/update-members	POST	Atomically add, update, or remove ring group members	Yes

OpenAPI Specification

Download the complete OpenAPI specification: ringgroup-api-v1.yaml