Sign in

v51

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-058638763.1 MB
Teams

Update Team

Updates an individual team.

patch/v3/teams/{teamId}

Request body

namestring nullable

The name of the team.

descriptionstring nullable

The description of the team.

labelsLabelsUpdate nullable

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Example request

{
  "name": "IDM - Developers",
  "description": "The Identity Management (IDM) API team.",
  "labels": {
    "env": "test"
  }
}

Response

A response including a single team.

idstring uuid

The team ID.

namestring nullable

The name of the team.

descriptionstring nullable

The team description in Konnect.

system_teamboolean

Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"

labelsLabels

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

created_atstring date-time

A Unix timestamp representation of team creation.

updated_atstring date-time

A Unix timestamp representation of the most recent change to the team object in Konnect.

Example response

{
  "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "name": "IDM - Developers",
  "description": "The developers for the IDM API.",
  "system_team": false,
  "labels": {
    "env": "test"
  },
  "created_at": "1992-02-07T17:46:57.52Z",
  "updated_at": "2022-08-31T17:00:00.52Z"
}