---
title: "Update Network"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-dev-2/versions/ecf70889-e649-4a6a-8151-214a472a1044/operations/update-network"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-dev-2/versions/ecf70889-e649-4a6a-8151-214a472a1044.md

# Update Network

`PATCH` `/cloud-gateways/networks/{networkId}`

Operation ID: `update-network`

Updates a network by ID.

## Path parameters

- `networkId` (string, uuid, required) - The network to operate on.

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Response format for patching a network.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found
- `409` - Conflict

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 2.0.0
servers:
  - url: https://global.api.konghq.com/v2
    description: Base URL for the global region
paths:
  /cloud-gateways/networks/{networkId}:
    patch:
      operationId: update-network
      summary: Update Network
      description: Updates a network by ID.
      parameters:
        - $ref: "#/components/parameters/NetworkId"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PatchNetworkRequest"
      responses:
        "200":
          $ref: "#/components/responses/PatchNetworkResponse"
        "400":
          $ref: "#/components/responses/CloudGatewaysBadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/CloudGatewaysForbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "409":
          $ref: "#/components/responses/Conflict"
      tags:
        - Networks
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    NetworkId:
      name: networkId
      in: path
      description: The network to operate on.
      required: true
      schema:
        $ref: "#/components/schemas/NetworkId"
  schemas:
    PatchNetworkRequest:
      description: Request schema for updating a network.
      type: object
      properties:
        name:
          $ref: "#/components/schemas/NetworkName"
        firewall:
          $ref: "#/components/schemas/NetworkFirewallConfig"
      additionalProperties: false
      title: PatchNetworkRequest
    NetworkId:
      description: The network ID to operate on. For serverless.v1 kind of cloud
        gateways, this field should be omitted.
      type: string
      format: uuid
      example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695
    NetworkName:
      description: Human-readable name of the network.
      type: string
      example: us-east-2 network
      title: Network Name
    NetworkFirewallConfig:
      description: Firewall configuration for a network.
      type: object
      properties:
        allowed_cidr_blocks:
          description: List of allowed CIDR blocks to access a network.
          type: array
          items:
            type: string
          example:
            - 10.0.0.0/8
          title: Allowed CIDR Blocks
        denied_cidr_blocks:
          description: List of denied CIDR blocks to access a network.
          type: array
          items:
            type: string
          example:
            - 10.100.0.0/16
          title: Denied CIDR Blocks
      additionalProperties: false
      title: Network Firewall Config
    Network:
      description: Object containing information about a network to be used in
        configurations.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/NetworkId"
        name:
          $ref: "#/components/schemas/NetworkName"
        default:
          description: >
            Whether the network is a default network or not. Default networks
            are Networks that are created

            automatically by Konnect when an organization is linked to a
            provider account.
          type: boolean
          example: false
        cloud_gateway_provider_account_id:
          $ref: "#/components/schemas/ProviderAccountId"
        region:
          $ref: "#/components/schemas/ProviderRegionId"
        availability_zones:
          $ref: "#/components/schemas/NetworkAvailabilityZones"
        cidr_block:
          $ref: "#/components/schemas/NetworkCIDRBlock"
        firewall:
          $ref: "#/components/schemas/NetworkFirewallConfig"
        ddos_protection:
          $ref: "#/components/schemas/NetworkDDOSProtection"
        state:
          $ref: "#/components/schemas/NetworkState"
        state_metadata:
          $ref: "#/components/schemas/NetworkStateMetadata"
        provider_metadata:
          $ref: "#/components/schemas/NetworkProviderMetadata"
        transit_gateway_count:
          description: The number of transit gateways attached to this network.
          type: integer
          example: 0
          readOnly: true
        configuration_reference_count:
          description: The number of configurations that reference this network.
          type: integer
          example: 0
          readOnly: true
        entity_version:
          description: >
            Monotonically-increasing version count of the network, to indicate
            the order of updates to the network.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of network creation date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of network update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - id
        - name
        - default
        - cloud_gateway_provider_account_id
        - region
        - availability_zones
        - cidr_block
        - provider_metadata
        - state
        - transit_gateway_count
        - configuration_reference_count
        - entity_version
        - created_at
        - updated_at
      title: Network
    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
    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
    ProviderAccountId:
      type: string
      format: uuid
      example: 929b2449-c69f-44c4-b6ad-9ecec6f811ae
    ProviderRegionId:
      description: Region ID for cloud provider region.
      type: string
      example: us-east-2
      title: Provider Region ID
    NetworkAvailabilityZones:
      description: List of availability zones that the network is attached to.
      type: array
      items:
        type: string
      example:
        - use2-az1
        - use2-az2
        - use2-az3
    NetworkCIDRBlock:
      description: CIDR block configuration for the network.
      type: string
      example: 10.0.0.0/8
      title: Network CIDR Block
    NetworkDDOSProtection:
      description: Whether DDOS protection is enabled for the network.
      type: boolean
      example: false
      title: Network DDOS Protection
    NetworkState:
      description: State of the network.
      enum:
        - created
        - initializing
        - offline
        - ready
        - terminating
        - terminated
      readOnly: true
      title: Network State
    NetworkStateMetadata:
      description: >
        Metadata describing the backing state of the network and why it may be
        in an erroneous state.
      type: object
      properties:
        reported_status:
          description: Reported status of the network from backing infrastructure.
          type: string
          example: INVALID
        reason:
          description: >
            Reason why the network may be in an erroneous state, reported from
            backing infrastructure.
          type: string
          example: >
            Network could not be deployed due to insufficient cloud provider
            compute instances.
      additionalProperties: false
      readOnly: true
      title: Network State Metadata
    NetworkProviderMetadata:
      description: Metadata describing attributes returned by cloud-provider for the
        network.
      type: object
      properties:
        vpc_id:
          type: string
          title: VPC ID
        subnet_ids:
          type: array
          items:
            type: string
          title: Subnet IDs
      additionalProperties: false
      readOnly: true
      title: Network Provider Metadata
    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
  responses:
    PatchNetworkResponse:
      description: Response format for patching a network.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Network"
    CloudGatewaysBadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
          examples:
            Network Name Length Exceeded:
              $ref: "#/components/examples/NetworkNameLengthCheckBadRequestExample"
            Transit Gateway Name Length Exceeded:
              $ref: "#/components/examples/TransitGatewayNameLengthCheckBadRequestExample"
            Custom Domain Domain Length Too Short:
              $ref: "#/components/examples/CustomDomainLengthCheckBadRequestExample"
            Configuration Api Access Enum Validation:
              $ref: "#/components/examples/ConfigurationApiAccessBadRequestExample"
            Configuration Data-Plane Group Static Request Instances Minimum:
              $ref: "#/components/examples/ConfigurationDataPlaneGroupStaticRequestedInstance\
                sBadRequestExample"
            Configuration Data-Plane Group Autopilot Base RPS Minimum:
              $ref: "#/components/examples/ConfigurationDataPlaneGroupAutopilotBaseRpsBadRequ\
                estExample"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    CloudGatewaysForbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            Permission Denied:
              $ref: "#/components/examples/PermissionDeniedExample"
            Quota Exceeded:
              $ref: "#/components/examples/QuotaExceededExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
    Conflict:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ConflictError"
  examples:
    NetworkNameLengthCheckBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: konnect:trace:2822394689570210664
        detail: Invalid Parameters
        invalid_parameters:
          - field: name
            rule: max_length
            reason: name must be shorter than or equal to 120 characters
            maximum: 120
    TransitGatewayNameLengthCheckBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: konnect:trace:2822394689570210664
        detail: Invalid Parameters
        invalid_parameters:
          - field: name
            rule: max_length
            reason: name must be shorter than or equal to 120 characters
            maximum: 120
    CustomDomainLengthCheckBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: konnect:trace:2822394689570210664
        detail: Invalid Parameters
        invalid_parameters:
          - field: domain
            rule: min_length
            minimum: 1
            reason: domain must be longer than or equal to 1 characters
    ConfigurationApiAccessBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: konnect:trace:2822394689570210664
        detail: Invalid Parameters
        invalid_parameters:
          - field: api_access
            rule: enum
            choices:
              - private
              - public
              - private+public
            reason: "api_access must be one of the following values: private, public,
              private+public"
    ConfigurationDataPlaneGroupStaticRequestedInstancesBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: konnect:trace:2822394689570210664
        detail: Invalid Parameters
        invalid_parameters:
          - field: dataplane_groups.0.autoscale.requested_instances
            rule: is_integer
            reason: dataplane_groups.0.autoscale.requested_instances must be an integer
              number
    ConfigurationDataPlaneGroupAutopilotBaseRpsBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: konnect:trace:2822394689570210664
        detail: Invalid Parameters
        invalid_parameters:
          - field: dataplane_groups.0.autoscale.base_rps
            rule: is_integer
            reason: dataplane_groups.0.autoscale.base_rps must be an integer number
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    PermissionDeniedExample:
      value:
        status: 403
        title: Forbidden
        instance: konnect:trace:2822394689570210664
        detail: You do not have permission to perform this action.
    QuotaExceededExample:
      value:
        status: 403
        title: Quota Exceeded
        instance: konnect:trace:2822394689570210664
        detail: "Maximum number of <quota name> exceeded. Max allowed: <quota value>."
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  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...'`
```
