find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/portainer-teams-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact:
    email: info@portainer.io
  description: Portainer API is an HTTP API served by Portainer.
  license:
    name: zlib
    url: https://github.com/portainer/portainer/blob/develop/LICENSE
  title: PortainerCE Teams API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Manage teams
  name: Teams
paths:
  /teams:
    get:
      description: 'List teams. For non-administrator users, will only list the teams they are member of.

        **Access policy**: restricted'
      operationId: TeamList
      parameters:
      - description: Only list teams that the user is leader of
        in: query
        name: onlyLedTeams
        schema:
          type: boolean
      - description: Identifier of the environment(endpoint) that will be used to filter the authorized teams
        in: query
        name: environmentId
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/portainer.Team'
                type: array
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: List teams
      tags:
      - Teams
    post:
      description: 'Create a new team.

        **Access policy**: administrator'
      operationId: TeamCreate
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.Team'
        '400':
          description: Invalid request
        '409':
          description: A team with the same name already exists
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Create a new team
      tags:
      - Teams
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teams.teamCreatePayload'
        description: details
        required: true
  /teams/{id}:
    delete:
      description: 'Remove a team.

        **Access policy**: administrator'
      operationId: TeamDelete
      parameters:
      - description: Team Id
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request
        '403':
          description: Permission denied
        '404':
          description: Team not found
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Remove a team
      tags:
      - Teams
    get:
      description: 'Retrieve details about a team. Access is only available for administrator and leaders of that team.

        **Access policy**: administrator'
      operationId: TeamInspect
      parameters:
      - description: Team identifier
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.Team'
        '400':
          description: Invalid request
        '403':
          description: Permission denied
        '404':
          description: Team not found
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Inspect a team
      tags:
      - Teams
    put:
      description: 'Update a team.

        **Access policy**: administrator'
      operationId: TeamUpdate
      parameters:
      - description: Team identifier
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.Team'
        '400':
          description: Invalid request
        '403':
          description: Permission denied
        '404':
          description: Team not found
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Update a team
      tags:
      - Teams
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teams.teamUpdatePayload'
        description: Team details
        required: true
components:
  schemas:
    teams.teamUpdatePayload:
      properties:
        Name:
          description: Name
          example: developers
          type: string
      type: object
    teams.teamCreatePayload:
      properties:
        Name:
          description: Name
          example: developers
          type: string
        TeamLeaders:
          description: TeamLeaders
          example:
          - 3
          - 5
          items:
            type: integer
          type: array
      required:
      - Name
      type: object
    portainer.Team:
      properties:
        Id:
          description: Team Identifier
          example: 1
          type: integer
        Name:
          description: Team name
          example: developers
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    jwt:
      in: header
      name: Authorization
      type: apiKey