Documentation Grafana Cloud Developer resources API reference Grafana HTTP API reference Team Sync HTTP API

Team Sync API

Team Sync is only available in Grafana Enterprise. Read more about Grafana Enterprise.

If you are running Grafana Enterprise, for some endpoints you’ll need to have specific permissions. Refer to Role-based access control permissions for more information.

Get External Groups

GET /api/teams/:teamId/groups

Required permissions

See note in the introduction for an explanation.

Example Request:

http Copy

GET /api/teams/1/groups HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer glsa_kcVxDhZtu5ISOZIEt

Example Response:

http Copy

HTTP/1.1 200
Content-Type: application/json

[
  {
    "orgId": 1,
    "teamId": 1,
    "groupId": "cn=editors,ou=groups,dc=grafana,dc=org"
  }
]

Status Codes:

• 200 - Ok
• 401 - Unauthorized
• 403 - Permission denied

Add External Group

POST /api/teams/:teamId/groups

Required permissions

See note in the introduction for an explanation.

Example Request:

http Copy

POST /api/teams/1/groups HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer YWRtaW46YWRtaW4=

{
  "groupId": "cn=editors,ou=groups,dc=grafana,dc=org"
}

Example Response:

http Copy

HTTP/1.1 200
Content-Type: application/json

{"message":"Group added to Team"}

Status Codes:

• 200 - Ok
• 400 - Group is already added to this team
• 401 - Unauthorized
• 403 - Permission denied
• 404 - Team not found

Remove External Group

DELETE /api/teams/:teamId/groups?groupId=external-group-id

Required permissions

See note in the introduction for an explanation.

Example Request:

http Copy

DELETE /api/teams/1/groups?groupId=cn%3Deditors%2Cou%3Dgroups%2Cdc%3Dgrafana%2Cdc%3Dorg HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer glsa_kcVxDhZtu5ISOZIEt

Example Response:

http Copy

HTTP/1.1 200
Content-Type: application/json

{"message":"Team Group removed"}

Status Codes:

• 200 - Ok
• 401 - Unauthorized
• 403 - Permission denied
• 404 - Team not found/Group not found