GET
/
v1
/
teams
/
groups
const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/teams/groups?name=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
{
  "group": {
    "groupId": {
      "id": 123
    },
    "name": "<string>",
    "description": "<string>",
    "externalId": "<string>",
    "groupOrigin": "GROUP_ORIGIN_UNSPECIFIED",
    "teamId": {
      "id": 123
    },
    "roles": [
      {
        "roleId": {
          "id": 123
        },
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "scope": {
      "id": {
        "id": 123
      },
      "filters": {
        "subsystems": [
          {
            "term": "<string>",
            "filterType": "FILTER_TYPE_UNSPECIFIED"
          }
        ],
        "applications": [
          {
            "term": "<string>",
            "filterType": "FILTER_TYPE_UNSPECIFIED"
          }
        ]
      }
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "nextGenScopeId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API key authentication

Query Parameters

name
string

Response

200
application/json

A successful response.

Response containing the complete details of a team group that matches the requested name, including its members, roles, and scope settings.