OpenObserve Groups API
The Groups API from OpenObserve — 2 operation(s) for groups.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/openobserve-groups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: openobserve Actions Groups API
description: OpenObserve API documents [https://openobserve.ai/docs/](https://openobserve.ai/docs/)
contact:
name: OpenObserve
url: https://openobserve.ai/
email: hello@zinclabs.io
license:
name: AGPL-3.0
identifier: AGPL-3.0
version: 0.90.0
servers:
- url: https://api.openobserve.ai
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Groups
paths:
/api/{org_id}/groups:
get:
tags:
- Groups
summary: List organization groups
description: Retrieves a list of all user groups in the organization. Users will only see groups they have permissions to view when role-based access control is active. Useful for managing group-based permissions and understanding organizational structure. Requires enterprise features to be enabled.
operationId: ListGroups
parameters:
- name: org_id
in: path
description: Organization name
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
type: string
'500':
description: Failure
content:
application/json:
schema:
default: null
security:
- Authorization: []
post:
tags:
- Groups
summary: Create user group
description: Creates a new user group with specified users and roles. Groups allow efficient management of permissions by assigning roles to groups instead of individual users. Requires enterprise features to be enabled.
operationId: CreateGroup
parameters:
- name: org_id
in: path
description: Organization name
required: true
schema:
type: string
requestBody:
description: UserGroup
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
type: string
roles:
type:
- array
- 'null'
items:
type: string
uniqueItems: true
users:
type:
- array
- 'null'
items:
type: string
uniqueItems: true
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
'500':
description: Failure
content:
application/json:
schema:
default: null
security:
- Authorization: []
/api/{org_id}/groups/{group_name}:
get:
tags:
- Groups
summary: Get group details
description: Retrieves detailed information about a specific user group including its members, assigned roles, and configuration. Useful for understanding group composition and permissions. Requires enterprise features to be enabled.
operationId: GetGroup
parameters:
- name: org_id
in: path
description: Organization name
required: true
schema:
type: string
- name: group_name
in: path
description: Group name
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
type: string
roles:
type:
- array
- 'null'
items:
type: string
uniqueItems: true
users:
type:
- array
- 'null'
items:
type: string
uniqueItems: true
'500':
description: Failure
content:
application/json:
schema:
default: null
security:
- Authorization: []
put:
tags:
- Groups
summary: Update user group
description: Updates an existing user group by adding or removing users and roles. Allows dynamic management of group membership and permissions to maintain proper access control. Requires enterprise features to be enabled.
operationId: UpdateGroup
parameters:
- name: org_id
in: path
description: Organization name
required: true
schema:
type: string
- name: group_name
in: path
description: Group name
required: true
schema:
type: string
requestBody:
description: UserGroupRequest
content:
application/json:
schema:
type: object
properties:
add_roles:
type:
- array
- 'null'
items:
type: string
uniqueItems: true
add_users:
type:
- array
- 'null'
items:
type: string
uniqueItems: true
remove_roles:
type:
- array
- 'null'
items:
type: string
uniqueItems: true
remove_users:
type:
- array
- 'null'
items:
type: string
uniqueItems: true
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
'500':
description: Failure
content:
application/json:
schema:
default: null
security:
- Authorization: []
delete:
tags:
- Groups
summary: Delete user group
description: Permanently removes a user group from the organization. Users in the group will lose group-based permissions but retain any directly assigned roles. This action cannot be undone. Requires enterprise features to be enabled.
operationId: DeleteGroup
parameters:
- name: org_id
in: path
description: Organization name
required: true
schema:
type: string
- name: group_name
in: path
description: Group name
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
'500':
description: Failure
content:
application/json:
schema:
default: null
security:
- Authorization: []
components:
securitySchemes:
Authorization:
type: apiKey
in: header
name: Authorization
BasicAuth:
type: http
scheme: basic