---
title: "Update the serverless cloud gateway"
url: "https://nov18-dev.movespot.fyi/apis/konnect-serverless-cloud-gateways-manager-dev-0/versions/01a8de1b-83df-494b-986c-1bc50e0f354d/operations/update-serverless-cloud-gateway"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-serverless-cloud-gateways-manager-dev-0/versions/01a8de1b-83df-494b-986c-1bc50e0f354d.md

# Update the serverless cloud gateway

`PATCH` `/serverless-cloud-gateways/{controlPlaneId}`

Operation ID: `update-serverless-cloud-gateway`

Update an individual serverless cloud gateway.

## Path parameters

- `controlPlaneId` (string, uuid, required) - Id of the Serverless Cloud Gateway control plane

## Request body (required)

Content types: `application/json`

## Responses

- `200` - A response to updating a serverless cloud gateway.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Serverless Cloud Gateways Manager
  version: 0.0.1
servers:
  - url: https://global.api.konghq.com/v0
    description: US Public API
paths:
  /serverless-cloud-gateways/{controlPlaneId}:
    parameters:
      - name: controlPlaneId
        in: path
        description: Id of the Serverless Cloud Gateway control plane
        required: true
        schema:
          type: string
          format: uuid
        example: bf138ba2-c9b1-4229-b268-04d9d8a6410b
    patch:
      operationId: update-serverless-cloud-gateway
      summary: Update the serverless cloud gateway
      description: Update an individual serverless cloud gateway.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateServerlessCloudGatewayRequest"
            examples:
              Example Request Body:
                $ref: "#/components/examples/UpdateServerlessCloudGatewayRequestExample"
      responses:
        "200":
          $ref: "#/components/responses/UpdateServerlessCloudGatewayResponse"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Serverless Cloud Gateways
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  schemas:
    UpdateServerlessCloudGatewayRequest:
      description: Schema to update a serverless cloud gateway.
      type: object
      properties:
        cp_prefix:
          description: The prefix of the serverless cloud gateway CP.
          type: string
          example: 518da50bf7
        cp_region:
          $ref: "#/components/schemas/CpRegion"
        labels:
          $ref: "#/components/schemas/SCGWLabels"
      additionalProperties: false
      title: UpdateServerlessCloudGatewayRequest
    CpRegion:
      description: The control plane region.
      type: string
      example: us
      enum:
        - us
        - eu
        - au
      title: Control plane region
      x-enum-varnames:
        - US
        - Europe
        - Aus
    SCGWLabels:
      description: Labels to facilitate tagged search on serverless cloud gateways.
        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
      title: Labels
    ServerlessCloudGateway:
      description: A serverless cloud gateway
      type: object
      properties:
        control_plane:
          $ref: "#/components/schemas/ServerlessControlPlane"
        gateway_endpoint:
          description: Endpoint for the serverless cloud gateway.
          type: string
          format: hostname
          example: us-kong-4594857kpl.kongcloud.dev
          readOnly: true
        created_at:
          type: string
          format: date-time
          example: 2023-01-11T02:30:42.227Z
          readOnly: true
        updated_at:
          type: string
          format: date-time
          example: 2023-01-11T02:30:42.227Z
          readOnly: true
        labels:
          $ref: "#/components/schemas/SCGWLabels"
      required:
        - control_plane
        - gateway_endpoint
        - updated_at
        - created_at
      title: ServerlessCloudGateway
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    ServerlessControlPlane:
      type: object
      properties:
        id:
          description: ID of the serverless cloud gateway CP.
          type: string
          format: uuid
          example: d32d905a-ed33-46a3-a093-d8f536af9a8a
        prefix:
          description: The prefix of the serverless cloud gateway CP.
          type: string
          example: 518da50bf7
        region:
          $ref: "#/components/schemas/CpRegion"
      required:
        - id
        - prefix
        - region
      title: Control plane
      x-go-name: ControlPlane
    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
    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:
    UpdateServerlessCloudGatewayRequestExample:
      value:
        labels:
          test: "true"
    ServerlessCloudGatewayExample:
      value:
        control_plane:
          id: d32d905a-ed33-46a3-a093-d8f536af9a8a
          prefix: 518da50bf7
          region: eu
        gateway_endpoint: kong-518da50bf7euab123.kongcloud.dev
        created_at: 2023-01-11T02:30:42.227Z
        updated_at: 2023-01-11T02:30:42.227Z
        labels:
          test: "true"
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  responses:
    UpdateServerlessCloudGatewayResponse:
      description: A response to updating a serverless cloud gateway.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ServerlessCloudGateway"
          examples:
            Update Serverless cloud gateway Response:
              $ref: "#/components/examples/ServerlessCloudGatewayExample"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  securitySchemes:
    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...'`
```
