---
title: "Get Resource Availability JSON"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b/operations/get-availability-json"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b.md

# Get Resource Availability JSON

`GET` `/cloud-gateways/availability.json`

Operation ID: `get-availability-json`

Get Cloud Gateways Availability JSON document for describing cloud provider and region availability, pricing, gateway version availability, and instance type information.

## Responses

- `200` - Response format for retrieving the cloud gateways availability JSON document.

## 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/availability.json:
    get:
      operationId: get-availability-json
      summary: Get Resource Availability JSON
      description: >
        Get Cloud Gateways Availability JSON document for describing cloud
        provider and region availability, pricing,

        gateway version availability, and instance type information.
      responses:
        "200":
          $ref: "#/components/responses/RetrieveCloudGatewaysAvailabilityDocumentResponse"
      security: []
      tags:
        - Resource Availability
security: []
components:
  responses:
    RetrieveCloudGatewaysAvailabilityDocumentResponse:
      description: Response format for retrieving the cloud gateways availability JSON
        document.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AvailabilityDocument"
  schemas:
    AvailabilityDocument:
      description: Document containing availability information for configurations.
      type: object
      properties:
        versions:
          $ref: "#/components/schemas/VersionList"
        instance_types:
          $ref: "#/components/schemas/InstanceTypes"
        providers:
          $ref: "#/components/schemas/Providers"
        serverless_v1_providers:
          $ref: "#/components/schemas/ServerlessV1Providers"
      additionalProperties: false
      required:
        - versions
        - instance_types
        - providers
        - serverless_v1_providers
      title: Availability Document
    VersionList:
      description: List of supported gateway versions for cloud gateways.
      type: array
      items:
        $ref: "#/components/schemas/GatewayVersion"
      readOnly: true
      title: Version List
    InstanceTypes:
      description: List of supported instance types, along with their associated
        resource parameters and pricing.
      type: array
      items:
        $ref: "#/components/schemas/InstanceType"
      title: Instance Types
    Providers:
      description: List of supported cloud providers that run cloud gateway instances.
      type: array
      items:
        $ref: "#/components/schemas/Provider"
      title: Providers
    ServerlessV1Providers:
      description: List of supported cloud providers that run serverless v1 cloud
        gateway instances.
      type: array
      items:
        $ref: "#/components/schemas/ServerlessV1Provider"
      title: Serverless V1 Providers
    GatewayVersion:
      description: Supported gateway version. For serverless.v1 kind of cloud
        gateways, this field should be omitted.
      type: string
      example: "3.2"
      title: Gateway Version
    InstanceType:
      description: Resource parameters and pricing of a given supported instance type.
      type: object
      properties:
        name:
          $ref: "#/components/schemas/InstanceTypeName"
        hourly_cost:
          description: Hourly cost to run a single cloud gateway instance of this instance
            type.
          type: string
          format: ^(\d)+(\.(\d)+)?$
          example: "1.00"
        v_cpu:
          description: Number of virtual CPUs available to a cloud gateway instance of
            this instance type.
          type: string
          format: ^(\d)+
          example: "2"
        gb_memory:
          description: Number of gigabytes of memory available to a cloud gateway instance
            of this instance type.
          type: string
          format: ^(\d)+
          example: "2"
      additionalProperties: false
      readOnly: true
      required:
        - name
        - hourly_cost
        - v_cpu
        - gb_memory
      title: Instance Type
    Provider:
      description: Description of cloud provider that runs cloud gateway instances.
      type: object
      properties:
        provider:
          $ref: "#/components/schemas/ProviderName"
        regions:
          $ref: "#/components/schemas/ProviderRegions"
      additionalProperties: false
      required:
        - provider
        - regions
      title: Provider
    ServerlessV1Provider:
      description: Description of cloud provider that runs serverless v1 cloud gateway
        instances.
      type: object
      properties:
        provider:
          $ref: "#/components/schemas/ServerlessV1ProviderName"
        regions:
          $ref: "#/components/schemas/ServerlessV1ProviderRegions"
      additionalProperties: false
      required:
        - provider
        - regions
      title: Serverless V1 Provider
    InstanceTypeName:
      description: Instance type name to indicate capacity.
      type: string
      enum:
        - small
        - medium
        - large
    ProviderName:
      description: Name of cloud provider.
      type: string
      example: aws
      enum:
        - aws
        - azure
        - gcp
      title: Provider Name
    ProviderRegions:
      description: List of available regions to run cloud gateway instances on for a
        given cloud provider.
      type: array
      items:
        $ref: "#/components/schemas/ProviderRegion"
      title: Provider Regions
    ServerlessV1ProviderName:
      description: Name of cloud provider.
      type: string
      example: aws
      enum:
        - aws
    ServerlessV1ProviderRegions:
      description: List of available regions to run serverless v1 cloud gateway
        instances on for a given cloud provider.
      type: array
      items:
        $ref: "#/components/schemas/ServerlessV1ProviderRegion"
      title: Serverless V1 Provider Regions
    ProviderRegion:
      description: Region ID and human-readable name for a cloud provider region.
      type: object
      properties:
        region:
          $ref: "#/components/schemas/ProviderRegionId"
        name:
          $ref: "#/components/schemas/ProviderRegionName"
        availability_zones:
          description: >
            List of supported availability zones for cloud provider region, for
            network AZ configuration.
          type: array
          items:
            type: string
          example:
            - use2-az1
            - use2-az2
            - use2-az3
        cidr_blocks:
          description: >
            List of supported CIDR blocks for cloud provider region, for network
            CIDR block configuration.
          type: array
          items:
            type: string
          example:
            - 10.0.0.0/8
            - 100.64.0.0/10
            - 172.16.0.0/12
            - 192.168.0.0/16
            - 198.18.0.0/15
        reserved_cidr_blocks:
          description: >
            List of reserved CIDR blocks for cloud provider region, to restrict
            allowed network CIDR block

            configuration.
          type: array
          items:
            type: string
          example:
            - 10.100.0.0/16
            - 172.17.0.0/16
      additionalProperties: false
      required:
        - region
        - name
        - availability_zones
        - cidr_blocks
        - reserved_cidr_blocks
      title: Provider Region
    ServerlessV1ProviderRegion:
      description: Region ID and human-readable name for a cloud provider region.
      type: object
      properties:
        region:
          $ref: "#/components/schemas/ServerlessV1ProviderRegionId"
      additionalProperties: false
      required:
        - region
      title: Serverless V1 Provider Region
    ProviderRegionId:
      description: Region ID for cloud provider region.
      type: string
      example: us-east-2
      title: Provider Region ID
    ProviderRegionName:
      description: >
        Human-readable name for cloud provider region. The list of available
        provider regions can be retrieved via the

        availability endpoint `/v2/cloud-gateways/availability.json`.
      type: string
      example: N. Virginia
      title: Provider Region Name
    ServerlessV1ProviderRegionId:
      description: Region ID for serverless v1 cloud provider region.
      type: string
      example: us
      title: Serverless V1 Provider Region ID
```
