Home
APIGen
Apigen Deployment Structure
Apigen Deployment Structure
A deployment record representing an API deployed to a target environment.
Type: object
Properties: 13
Required: 7
Code Documentation Generation Open-Source PHP
APIGen Deployment is a JSON Structure definition published by APIGen, describing 13 properties, of which 7 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
id
apiId
projectId
environment
status
url
version
region
replicas
logs
deployedBy
createdAt
updatedAt
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://api.apigen.com/schemas/deployment.json",
"description": "A deployment record representing an API deployed to a target environment.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the deployment."
},
"apiId": {
"type": "string",
"description": "ID of the deployed API."
},
"projectId": {
"type": "string",
"description": "ID of the parent project."
},
"environment": {
"type": "string",
"enum": [
"development",
"staging",
"production"
],
"description": "Target environment for the deployment."
},
"status": {
"type": "string",
"enum": [
"pending",
"in_progress",
"deployed",
"failed",
"torn_down"
],
"description": "Current status of the deployment."
},
"url": {
"type": [
"string",
"null"
],
"description": "Live URL of the deployed API, available once deployment succeeds."
},
"version": {
"type": "string",
"description": "Version of the API that was deployed."
},
"region": {
"type": "string",
"description": "Cloud region where the API is deployed."
},
"replicas": {
"type": "int32",
"minimum": 1,
"default": 1,
"description": "Number of running instances."
},
"logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"level": {
"type": "string",
"enum": [
"info",
"warn",
"error"
]
},
"message": {
"type": "string"
}
},
"required": [
"timestamp",
"level",
"message"
]
},
"description": "Deployment log entries."
},
"deployedBy": {
"type": "string",
"description": "User ID of the person who initiated the deployment."
},
"createdAt": {
"type": "datetime",
"description": "Timestamp when the deployment was initiated."
},
"updatedAt": {
"type": "datetime",
"description": "Timestamp when the deployment record was last updated."
}
},
"required": [
"id",
"apiId",
"projectId",
"environment",
"status",
"createdAt",
"updatedAt"
],
"additionalProperties": false,
"name": "APIGen Deployment"
}
Every JSON Structure 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 json structure
4 MCP tools reach this
find_json_structuresBrowse and filter every JSON Structure 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 Structure
curl "https://apis.io/api/v1/json-structures/apigen-deployment-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?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.