From fc6ea25ebdc8250b83e4f2f23bfe71cace720779 Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Fri, 1 Apr 2022 15:46:02 +0200 Subject: [PATCH] docs: add more endpoint data --- website/docs/api/admin/segments.mdx | 40 +++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/website/docs/api/admin/segments.mdx b/website/docs/api/admin/segments.mdx index 6ef8883ab6a..f8ded71efef 100644 --- a/website/docs/api/admin/segments.mdx +++ b/website/docs/api/admin/segments.mdx @@ -1,9 +1,45 @@ --- title: /api/admin/segments --- -export const basePath = "/api/admin/segments" +import ApiRequest from '@site/src/components/ApiRequest' +export const basePath = "api/admin/segments" +export const path = (p) => `api/admin/segments/${p}` -### Get all segments: `GET /{{{basePath}}}` +:::info Availability +The segments API is available to Pro and Enterprise users from Unleash 4.10. +::: + +:::note +To use the admin API, you'll need to [create and use an admin API token](../../user_guide/token.md). +::: + +The segments API lets you create, read, update, and delete [segments](../../reference/segments.mdx). + +### Get all segments + + + +
+ +Responses + +##### 200 OK + +The user no longer has the specified role in the project. If the user had this role prior to this API request, they will have been removed from the project. This response has no body. + +##### 400 Bad Request + +You tried to remove the only user with the role `owner` in the project: + +``` json +[ + { + "msg": "A project must have at least one owner." + } +] +``` + +
### Create segment: `POST /`