Home
WSO2
Publisher Api Api Revision Deployment Structure
Publisher Api Api Revision Deployment Structure
APIRevisionDeployment schema from WSO2 API Manager
Type: object
Properties: 10
API Management Gateways Open Source API Lifecycle GraphQL SOAP REST
APIRevisionDeployment Info object with basic API deployment details is a JSON Structure definition published by WSO2, describing 10 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
revisionUuid
name
status
vhost
displayOnDevportal
deployedTime
successDeployedTime
liveGatewayCount
deployedGatewayCount
failedGatewayCount
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-structure/publisher-api-api-revision-deployment-structure.json",
"name": "APIRevisionDeployment Info object with basic API deployment details",
"description": "APIRevisionDeployment schema from WSO2 API Manager",
"type": "object",
"properties": {
"revisionUuid": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"example": "c26b2b9b-4632-4ca4-b6f3-521c8863990c"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"example": "Default"
},
"status": {
"type": "string",
"example": "CREATED",
"default": "CREATED",
"enum": [
"CREATED",
"APPROVED",
"REJECTED"
]
},
"vhost": {
"maxLength": 255,
"minLength": 1,
"pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$",
"type": "string",
"example": "mg.wso2.com"
},
"displayOnDevportal": {
"type": "boolean",
"example": true,
"default": true
},
"deployedTime": {
"readOnly": true,
"type": "datetime"
},
"successDeployedTime": {
"readOnly": true,
"type": "datetime"
},
"liveGatewayCount": {
"readOnly": true,
"type": "int32",
"description": "The number of gateways that are currently live in the gateway environment\n",
"example": 1
},
"deployedGatewayCount": {
"readOnly": true,
"type": "int32",
"description": "The number of gateways in which the API revision is deployed successfully\n",
"example": 1
},
"failedGatewayCount": {
"readOnly": true,
"type": "int32",
"description": "The number of gateways where the API revision deployment has failed\n",
"example": 1
}
}
}