Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Groups

Get Direct Group

Retrieve a specific group by its instance key.

get/v2/schema/{proj_id}/{env_id}/groups/direct/{group_instance_key}

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

group_instance_keystring required

Either the unique id of the resource instance, or the URL-friendly key of the resource instance (i.e: the "slug").

Either the unique id of the resource instance, or the URL-friendly key of the resource instance (i.e: the "slug").

Response

Successful Response

group_resource_type_keystring

The key of the resource type that the group belongs to.

group_instance_keystring required

Either the unique id of the resource instance that that the group belongs to, or the URL-friendly key of the <resource_key:resource_instance_key> (i.e: file:my_file)

group_tenantstring required

The tenant key or id that the group belongs to.

idstring uuid required

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "group_resource_type_key": "company",
  "group_instance_key": "Acme",
  "group_tenant": "business"
}