APIGen · JSON Structure

Apigen Deployment Structure

A deployment record representing an API deployed to a target environment.

Type: object Properties: 13 Required: 7
CodeDocumentationGenerationOpen SourcePHP

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

Raw ↑ 
{
  "$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"
}