Convex · Schema

CreateDeployKeyRequest

BackendDatabaseFunctionsReal-TimeReactiveServerlessTypeScript

Properties

Name Type Description
deployment_name string The name of the deployment this key should be scoped to.
key_name string Optional human-readable name for the deploy key.
View JSON Schema on GitHub

JSON Schema

convex-createdeploykeyrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateDeployKeyRequest",
  "title": "CreateDeployKeyRequest",
  "type": "object",
  "required": [
    "deployment_name"
  ],
  "properties": {
    "deployment_name": {
      "type": "string",
      "description": "The name of the deployment this key should be scoped to."
    },
    "key_name": {
      "type": "string",
      "description": "Optional human-readable name for the deploy key."
    }
  }
}