teams

Inspect a team

Changed on

Retrieve details about a team. Access is only available for administrator and leaders of that team. Access policy: administrator

get/teams/{id}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/teams/{id}
  • Auth
    • API key in header X-API-KEY
    • or API key in header Authorization

Path parameters

idinteger required

Team identifier

Response

Success

DenyPortainerAccessboolean

Whether members of this team are denied access to Portainer itself (EE only)

Idinteger

Team Identifier

Namestring

Team name

Example response

{
  "Id": 1,
  "Name": "developers"
}

Changes