---
title: "Update API"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-dev-3/versions/b2fc1681-05e8-4b55-9b8c-8bbcc7654d1b/operations/update-api"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-dev-3/versions/b2fc1681-05e8-4b55-9b8c-8bbcc7654d1b.md

# Update API

`PATCH` `/apis/{apiId}`

Operation ID: `update-api`

Updates an API.

## Path parameters

- `apiId` (string, uuid, required) - The UUID API identifier

## Query parameters

- `force` (string, optional) - If true, allows operations to be removed from the current version when using access control enforcement. If false, operations removal will be rejected with a 409 error. Omitting the value means true.

## Request body (required)

Content types: `application/json`

## Responses

- `200` - API
- `400` - Bad Request
- `401` - ApiUnauthorized
- `403` - ApiForbidden
- `404` - Not Found
- `409` - Conflict - May occur when constraints are violated
- `415` - Unsupported Media Type

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect API Catalog
  version: 3.1.2
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
paths:
  /apis/{apiId}:
    parameters:
      - name: apiId
        in: path
        description: The UUID API identifier
        required: true
        schema:
          type: string
          format: uuid
          example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
    patch:
      operationId: update-api
      summary: Update API
      description: Updates an API.
      parameters:
        - name: force
          in: query
          description: >
            If true, allows operations to be removed from the current version
            when using access control enforcement.

            If false, operations removal will be rejected with a 409 error.

            Omitting the value means true.
          schema:
            type: string
            default: "false"
            enum:
              - "true"
              - "false"
      requestBody:
        $ref: "#/components/requestBodies/UpdateApiRequest"
      responses:
        "200":
          $ref: "#/components/responses/ApiResponse"
        "400":
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                ApiNameBadRequestExample:
                  $ref: "#/components/examples/ApiNameBadRequestExample"
        "401":
          $ref: "#/components/responses/ApiUnauthorized"
        "403":
          $ref: "#/components/responses/ApiForbidden"
        "404":
          $ref: "#/components/responses/ApiNotFound"
        "409":
          $ref: "#/components/responses/ApiVersionPatchConflict"
        "415":
          $ref: "#/components/responses/UnsupportedMediaType"
      tags:
        - API
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  requestBodies:
    UpdateApiRequest:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                description: The API identifier.
                type: string
                format: uuid
                example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
                readOnly: true
              name:
                description: >
                  The name of your API. The `name + version` combination must be
                  unique for each API you publish.
                type: string
                example: MyAPI
                maxLength: 255
                minLength: 1
              description:
                description: A description of your API. Will be visible on your live Portal.
                type: string
                nullable: true
              version:
                description: An optional version for your API. Leave this empty if your API is
                  unversioned.
                type: string
                maxLength: 255
                minLength: 1
                nullable: true
              current_version_summary:
                $ref: "#/components/schemas/ApiVersionSummary"
              slug:
                description: >
                  The `slug` is used in generated URLs to provide human readable
                  paths.


                  Defaults to `slugify(name + version)`
                type: string
                example: my-api-v1
                nullable: true
                pattern: ^[\w-]+$
              api_spec_ids:
                description: The list of API specification ids for the API.
                type: array
                items:
                  type: string
                  format: uuid
                  description: The id of the API specification.
                  example: 123e4567-e89b-12d3-a456-426614174000
                deprecated: true
                readOnly: true
              portals:
                description: The list of portals which this API is published to.
                type: array
                items:
                  type: object
                  additionalProperties: false
                  required:
                    - id
                    - name
                    - display_name
                  properties:
                    id:
                      description: The portal identifier.
                      type: string
                      format: uuid
                      example: 25a2624c-49fc-4764-99e1-224ed819f200
                    name:
                      description: The name of the portal, used to distinguish it from other portals.
                      type: string
                      example: My Portal
                    display_name:
                      description: The display name of the portal. This value will be the portal's
                        `name` in Portal API.
                      type: string
                      example: My Portal
                nullable: false
                readOnly: true
                uniqueItems: true
              labels:
                $ref: "#/components/schemas/LabelsUpdate"
              implementation_mode:
                description: the implementations that are associated with this api either
                  gateway_entity_binding or access_control_enforcement
                type: string
                nullable: true
                readOnly: true
              attributes:
                $ref: "#/components/schemas/ApiAttributes"
              created_at:
                $ref: "#/components/schemas/CreatedAt"
              updated_at:
                $ref: "#/components/schemas/UpdatedAt"
            additionalProperties: false
            title: API
          examples:
            UpdateApiName:
              $ref: "#/components/examples/UpdateApiNameRequestExample"
            UpdateApiVersion:
              $ref: "#/components/examples/UpdateApiVersionRequestExample"
  responses:
    ApiResponse:
      description: API
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ApiResponseSchema"
          examples:
            CreateApiResponse:
              $ref: "#/components/examples/ApiExample"
    ApiUnauthorized:
      description: ApiUnauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            ApiUnauthorizedExample:
              $ref: "#/components/examples/ApiUnauthorizedExample"
    ApiForbidden:
      description: ApiForbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            ApiForbiddenExample:
              $ref: "#/components/examples/ApiForbiddenExample"
    ApiNotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            ApiNotFoundExample:
              $ref: "#/components/examples/ApiNotFoundExample"
    ApiVersionPatchConflict:
      description: Conflict - May occur when constraints are violated
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ConflictError"
          examples:
            ApiOperationsRemovalConflictExample:
              $ref: "#/components/examples/ApiOperationsRemovalConflictExample"
            ApiSpecHiddenConflictExample:
              $ref: "#/components/examples/ApiSpecHiddenConflictExample"
    UnsupportedMediaType:
      description: Unsupported Media Type
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnsupportedMediaTypeError"
          examples:
            UnsupportedMediaTypeExample:
              $ref: "#/components/examples/UnsupportedMediaTypeExample"
  schemas:
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    ApiVersionSummary:
      type: object
      properties:
        id:
          description: The API version identifier.
          type: string
          format: uuid
          example: 7710d5c4-d902-410b-992f-18b814155b53
          readOnly: true
        version:
          description: The version of this api spec.
          type: string
        spec:
          type: object
          additionalProperties: false
          properties:
            type:
              $ref: "#/components/schemas/ApiSpecType"
            provider:
              description: Provenance of the spec for the current version. Present when a spec
                exists.
              oneOf:
                - $ref: "#/components/schemas/RawApiSpecProvider"
                - $ref: "#/components/schemas/UrlApiSpecProvider"
                - $ref: "#/components/schemas/IntegrationApiSpecProviderPayload"
                - $ref: "#/components/schemas/ResourceBoundIntegrationApiSpecProviderPayload"
              title: ApiSpecProvider
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      nullable: true
      readOnly: true
      title: API Version Summary
    LabelsUpdate:
      description: >
        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 "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
        nullable: true
      maxProperties: 50
      nullable: true
      writeOnly: true
    ApiAttributes:
      description: A set of attributes that describe the API
      type: object
      example:
        env:
          - production
        domains:
          - web
          - mobile
      default: {}
      additionalProperties:
        nullable: true
        description: Set of attributes with unique keys. Each key can include lowercase
          letters, numbers, hyphens, and underscores.
        type: array
        minItems: 1
        maxItems: 20
        items:
          type: string
          minLength: 1
          maxLength: 512
          pattern: ^[^,<>]*$
      nullable: false
      title: API Attributes
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    ApiResponseSchema:
      type: object
      properties:
        id:
          description: The API identifier.
          type: string
          format: uuid
          example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
          readOnly: true
        name:
          description: >
            The name of your API. The `name + version` combination must be
            unique for each API you publish.
          type: string
          example: MyAPI
          maxLength: 255
          minLength: 1
        description:
          description: A description of your API. Will be visible on your live Portal.
          type: string
          nullable: true
        version:
          description: An optional version for your API. Leave this empty if your API is
            unversioned.
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        current_version_summary:
          $ref: "#/components/schemas/ApiVersionSummary"
        slug:
          description: >
            The `slug` is used in generated URLs to provide human readable
            paths.


            Defaults to `slugify(name + version)`
          type: string
          example: my-api-v1
          nullable: true
          pattern: ^[\w-]+$
        api_spec_ids:
          description: The list of API specification ids for the API.
          type: array
          items:
            type: string
            format: uuid
            description: The id of the API specification.
            example: 123e4567-e89b-12d3-a456-426614174000
          deprecated: true
          readOnly: true
        portals:
          description: The list of portals which this API is published to.
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - id
              - name
              - display_name
            properties:
              id:
                description: The portal identifier.
                type: string
                format: uuid
                example: 25a2624c-49fc-4764-99e1-224ed819f200
              name:
                description: The name of the portal, used to distinguish it from other portals.
                type: string
                example: My Portal
              display_name:
                description: The display name of the portal. This value will be the portal's
                  `name` in Portal API.
                type: string
                example: My Portal
          nullable: false
          readOnly: true
          uniqueItems: true
        labels:
          $ref: "#/components/schemas/Labels"
        implementation_mode:
          description: the implementations that are associated with this api either
            gateway_entity_binding or access_control_enforcement
          type: string
          nullable: true
          readOnly: true
        attributes:
          $ref: "#/components/schemas/ApiAttributes"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        images:
          type: object
          example:
            icon:
              uri: /apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw
          additionalProperties: false
          nullable: true
          properties:
            icon:
              type: object
              additionalProperties: false
              nullable: true
              properties:
                uri:
                  description: The relative API path for retrieving the raw the icon image.
                  type: string
                  format: uri-reference
                  nullable: true
                  pattern: ^/[^\s]+/images/icon/raw$
          readOnly: true
          title: Images
      additionalProperties: false
      required:
        - id
        - name
        - version
        - labels
        - created_at
        - updated_at
        - slug
        - portals
        - api_spec_ids
        - current_version_summary
      title: API
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    ConflictError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 409
            title:
              example: Conflict
            type:
              example: https://httpstatuses.com/409
            instance:
              example: kong:trace:1234567890
            detail:
              example: Conflict
    UnsupportedMediaTypeError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 415
            title:
              example: UnsupportedMediaType
            type:
              example: https://httpstatuses.com/415
            instance:
              example: kong:trace:1234567890
            detail:
              example: UnsupportedMediaType
    ApiSpecType:
      description: >
        The type of specification being stored. This allows us to render the
        specification correctly.
      type: string
      example: oas3
      enum:
        - oas2
        - oas3
        - asyncapi
      title: API Spec Type
    RawApiSpecProvider:
      type: object
      properties:
        type:
          type: string
          enum:
            - raw
        config:
          type: object
          additionalProperties: false
          maxProperties: 0
          minProperties: 0
      required:
        - type
        - config
    UrlApiSpecProvider:
      type: object
      properties:
        type:
          type: string
          enum:
            - url
        config:
          type: object
          properties:
            url:
              description: |
                Public URL that resolves to the raw API spec contents.
                Supported formats are JSON and YAML.
              type: string
              format: uri
              example: https://api.petstore.com/v3/openapi.json
          required:
            - url
      required:
        - type
        - config
    IntegrationApiSpecProviderPayload:
      description: >
        API spec provider registered by a catalog integration.


        Integrations can function as API spec providers where they register a
        globally unique

        `type` and config schema which defines the shape of `config`.


        Consult integration documentation to learn more about available API spec
        providers.
      type: object
      properties:
        type:
          description: The globally unique API spec provider type that is registered by a
            given catalog integration.
          type: string
          example: swaggerhub_api_version
          maxLength: 120
          minLength: 1
        config:
          description: JSON object containing values as defined by integration provider's
            config schema.
          type: object
          example:
            owner: petco
            api: pet_store
            version: v3
          additionalProperties: true
          minProperties: 1
        integration_instance:
          description: The integration instance id or name
          type: string
      required:
        - type
        - config
        - integration_instance
    ResourceBoundIntegrationApiSpecProviderPayload:
      description: >
        API spec provider registered by a catalog integration.


        These providers differ from `IntegrationApiSpecProvider` in that they

        denote a binding relationship between a resource type and the API spec.

        This means that the API Spec will automatically be created/deleted
        for/from a service

        as resources of the given type are mapped/unmapped.


        Consult integration documentation to learn more about available API spec
        providers.
      type: object
      properties:
        type:
          description: >
            The globally unique API spec provider type that is registered by a
            given catalog integration.

            Resource-bound providers create a 1-to-1 mapping between a resource
            type and the API Spec.
          type: string
          maxLength: 120
          minLength: 1
        config:
          type: object
          properties:
            resource_id:
              description: ID of the associated Resource the API spec is bound to.
              type: string
              example: IqkHvMdyHukxcwAs
          required:
            - resource_id
      required:
        - type
        - config
    Labels:
      description: >
        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 "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    ApiNameBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:8405749052424858251
        detail: Invalid Parameters
        invalid_parameters:
          - field: name
            rule: min_length
            minimum: 1
            reason: name must be longer than or equal to 1 characters
    UpdateApiNameRequestExample:
      summary: Update API Name
      value:
        name: new API name
    UpdateApiVersionRequestExample:
      summary: Update API Version
      value:
        version: v2
    ApiExample:
      value:
        id: 9f5061ce-78f6-4452-9108-ad7c02821fd5
        name: myAPI
        version: v1
        labels:
          env: test
        description: My API
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
        slug: my-api-v1
        current_version_summary:
          id: 7710d5c4-d902-410b-992f-18b814155b53
          version: v1
          spec:
            type: oas3
          created_at: 2023-01-01T00:00:00.000Z
          updated_at: 2023-01-01T00:00:00.000Z
        portals:
          - id: 25a2624c-49fc-4764-99e1-224ed819f200
            name: My-Portal
            display_name: My Portal
        api_spec_ids:
          - 123e4567-e89b-12d3-a456-426614174000
        images:
          icon:
            uri: /apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw
    ApiUnauthorizedExample:
      value:
        status: 401
        title: ApiUnauthorized
        instance: kong:trace:8347343766220159418
        detail: ApiUnauthorized
    ApiForbiddenExample:
      value:
        status: 403
        title: ApiForbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    ApiNotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
    ApiOperationsRemovalConflictExample:
      value:
        status: 409
        title: Conflict
        instance: kong:trace:1234567890123456789
        detail: Operations are not allowed to be removed from the current version when
          using access control enforcement
    ApiSpecHiddenConflictExample:
      value:
        status: 409
        title: Conflict
        instance: kong:trace:9039922446017540182
        detail: Key (api_id, path)=(23380be0-c15e-4ca8-bcf7-43aadddc91b1, hidden.yaml)
          already exists.
    UnsupportedMediaTypeExample:
      value:
        status: 415
        title: Unsupported Media Type
        instance: kong:trace:8347343766220159418
        detail: "This API only supports requests with `Content-Type: application/json`"
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
