You're viewing version 2.16 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Get model group

Introduced 2.12

The Get Model Group API returns information about a model group based on that group’s ID.

If model access control is enabled on your cluster, only the owner or users with matching backend roles can get private model groups. Any user can get any public model group.

If model access control is disabled on your cluster, users with the get model group API permission can get any model group.

For more information, see Model access control.

Path and HTTP method

GET /_plugins/_ml/model_groups/<model_group_id>

Example request

The following example request gets a model group based on that group’s ID:

GET /_plugins/_ml/model_groups/<model_group_id>

Example response

The following response returns the model group information, including the model group’s name, version, description, access level, and creation information:

{
  "name": "test_model_group",
  "latest_version": 0,
  "description": "This is a public model group",
  "access": "public",
  "created_time": 1715112992748,
  "last_updated_time": 1715112992748
}