CreateDeploymentRequest

Requests API Gateway to create a Deployment resource.

APIs.ioEngineeringPlatform

Properties

Name Type Description
stageName object
stageDescription object
description object
cacheClusterEnabled object
cacheClusterSize object
variables object
canarySettings object
tracingEnabled object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-createdeploymentrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateDeploymentRequest",
  "title": "CreateDeploymentRequest",
  "type": "object",
  "properties": {
    "stageName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the Stage resource for the Deployment resource to create."
        }
      ]
    },
    "stageDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The description of the Stage resource for the Deployment resource to create."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The description for the Deployment resource to create."
        }
      ]
    },
    "cacheClusterEnabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableBoolean"
        },
        {
          "description": "Enables a cache cluster for the Stage resource specified in the input."
        }
      ]
    },
    "cacheClusterSize": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CacheClusterSize"
        },
        {
          "description": "The stage's cache capacity in GB. For more information about choosing a cache size, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html\">Enabling API caching to enhance responsiveness</a>."
        }
      ]
    },
    "variables": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToString"
        },
        {
          "description": "A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&amp;=,]+</code>."
        }
      ]
    },
    "canarySettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeploymentCanarySettings"
        },
        {
          "description": "The input configuration for the canary deployment when the deployment is a canary release deployment. "
        }
      ]
    },
    "tracingEnabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableBoolean"
        },
        {
          "description": "Specifies whether active tracing with X-ray is enabled for the Stage."
        }
      ]
    }
  },
  "description": "Requests API Gateway to create a Deployment resource."
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/apis-io-engineering-platform-createdeploymentrequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.