---
title: "APIGatewayRoute"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-api-gateways-dev-1/versions/a1769dd8-5923-4feb-8924-2e1ea4c75174/schemas/APIGatewayRoute"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-api-gateways-dev-1/versions/a1769dd8-5923-4feb-8924-2e1ea4c75174.md

# APIGatewayRoute

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Control Planes Configuration for API Gateways
  version: 1.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    BaseAPIGatewayRoute:
      type: object
      properties:
        name:
          description: The name of the API Gateway Route.
          type: string
          maxLength: 255
          minLength: 1
          x-unicode-pattern: ^[\p{L}\p{N}][\p{L}\p{N} _\-\.:/+']*[\p{L}\p{N}]$
        description:
          description: A human-readable description of the route.
          type: string
        path:
          description: The path to match for the route.
          type: string
        labels:
          $ref: "#/components/schemas/Labels"
      required:
        - name
        - path
    APIGatewayServiceReference:
      description: A reference to an existing service by ID.
      type: object
      properties:
        id:
          description: The ID of the service
          type: string
          format: uuid
        name:
          description: The name identifier of the service
          type: string
          maxLength: 255
          minLength: 1
      required:
        - id
        - name
    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
    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
    APIGatewayRoute:
      allOf:
        - $ref: "#/components/schemas/BaseAPIGatewayRoute"
        - type: object
          required:
            - id
            - created_at
            - updated_at
          properties:
            id:
              description: The ID of the service.
              type: string
              format: uuid
            default_service:
              $ref: "#/components/schemas/APIGatewayServiceReference"
            created_at:
              $ref: "#/components/schemas/CreatedAt"
            updated_at:
              $ref: "#/components/schemas/UpdatedAt"
```
