> For the complete documentation index, see [llms.txt](https://docs.bbchain.com.br/bbchain-ebs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bbchain.com.br/bbchain-ebs/bbchain-ebs-pt/para-desenvolvedores/api-reference/network-management/apps/app-deploy-web-adapter.md). # App Deploy Web Adapter ## GET /v1/apps/deployment/{deploy-id} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://apps-p-bk-api.saas.ebs.bbchain.network","description":"Generated server url"}],"paths":{"/v1/apps/deployment/{deploy-id}":{"get":{"tags":["app-deploy-web-adapter"],"operationId":"getDeploymentById","parameters":[{"name":"deploy-id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailedDeployment"}}}}}}}},"components":{"schemas":{"DetailedDeployment":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"app":{"$ref":"#/components/schemas/AppDTO"},"version":{"$ref":"#/components/schemas/AppVersionSelector"},"node":{"$ref":"#/components/schemas/DeployedNode"},"network":{"$ref":"#/components/schemas/DeployedNetwork"},"contractAddress":{"type":"string"},"apiAddress":{"type":"string"},"apiArguments":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentArgument"}},"constructorArguments":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentArgument"}},"status":{"type":"string","enum":["INSTALLED","INSTALLING","UNINSTALING","ERROR"]},"installedAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"integer","format":"int64"}}},"AppDTO":{"type":"object","properties":{"name":{"type":"string"},"developer":{"type":"string"},"description":{"type":"string"},"appIcon":{"type":"string"},"appBanner":{"type":"string"},"showMarketplace":{"type":"boolean"},"customerId":{"type":"integer","format":"int64"},"id":{"type":"integer","format":"int64"},"lastVersion":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"myRoles":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"integer","format":"int64"}},"required":["customerId","description","developer","name"]},"AppVersionSelector":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"declaredVersion":{"type":"string"},"targetPlatformVersion":{"type":"string"},"minimumPlatformVersion":{"type":"string"},"currentStatus":{"type":"string","enum":["ACTIVATED","DISABLED","ACTIVATING","DEACTIVATING","ERROR","DELETING","DELETED"]},"appId":{"type":"integer","format":"int64"},"workflows":{"type":"string","format":"binary"},"contracts":{"type":"string","format":"binary"},"apiFile":{"type":"string","format":"binary"},"config":{"type":"string","format":"binary"},"certificate":{"type":"string","format":"binary"},"workflowsFileName":{"type":"string"},"contractsFileName":{"type":"string"},"apiFileName":{"type":"string"},"configFileName":{"type":"string"},"certificateFileName":{"type":"string"},"binName":{"type":"string"},"binFile":{"type":"string","format":"binary"},"abiName":{"type":"string"},"abiFile":{"type":"string","format":"binary"},"constructorVars":{"type":"string"},"ptahContract":{"type":"string","format":"binary"},"ptahContractName":{"type":"string"},"contractCall":{"type":"string"},"contractConfirmationCall":{"type":"string"},"version":{"type":"string"},"kind":{"type":"string","enum":["API","SMART_CONTRACT"]},"dltType":{"type":"string"},"protocols":{"type":"array","items":{"$ref":"#/components/schemas/AppProtocol"}},"apiTechnology":{"type":"string"},"apiTechnologyName":{"type":"string"},"apiVars":{"type":"string"}},"required":["dltType","kind","version"]},"AppProtocol":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"tag":{"type":"string"},"name":{"type":"string"},"icon":{"type":"string"}},"required":["icon","id","name","tag"]},"DeployedNode":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"DeployedNetwork":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"protocol":{"type":"string"},"protocolId":{"type":"integer","format":"int64"}}},"DeploymentArgument":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}} ``` ## PUT /v1/apps/deployment/{deploy-id} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://apps-p-bk-api.saas.ebs.bbchain.network","description":"Generated server url"}],"paths":{"/v1/apps/deployment/{deploy-id}":{"put":{"tags":["app-deploy-web-adapter"],"operationId":"updateDeployment","parameters":[{"name":"deploy-id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppDeploymentUpdate"}}},"required":true},"responses":{"200":{"description":"OK"}}}}},"components":{"schemas":{"AppDeploymentUpdate":{"type":"object","properties":{"node":{"$ref":"#/components/schemas/AppNodeDeploymentItem"},"version":{"type":"string"}},"required":["version"]},"AppNodeDeploymentItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"deploymentName":{"type":"string"},"apiArguments":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentArgument"}},"contractArguments":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentArgument"}}},"required":["id"]},"DeploymentArgument":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}} ``` ## DELETE /v1/apps/deployment/{deploy-id} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://apps-p-bk-api.saas.ebs.bbchain.network","description":"Generated server url"}],"paths":{"/v1/apps/deployment/{deploy-id}":{"delete":{"tags":["app-deploy-web-adapter"],"operationId":"removeDeploymentById","parameters":[{"name":"deploy-id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## POST /v1/apps/{app-id}/deployment > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://apps-p-bk-api.saas.ebs.bbchain.network","description":"Generated server url"}],"paths":{"/v1/apps/{app-id}/deployment":{"post":{"tags":["app-deploy-web-adapter"],"operationId":"deployAppVersion","parameters":[{"name":"app-id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppDeployment"}}},"required":true},"responses":{"200":{"description":"OK"}}}}},"components":{"schemas":{"AppDeployment":{"type":"object","properties":{"nodes":{"type":"array","items":{"$ref":"#/components/schemas/AppNodeDeploymentItem"}},"version":{"type":"string"}},"required":["nodes","version"]},"AppNodeDeploymentItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"deploymentName":{"type":"string"},"apiArguments":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentArgument"}},"contractArguments":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentArgument"}}},"required":["id"]},"DeploymentArgument":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}} ``` ## PATCH /v1/apps/{app-id}/deployment > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://apps-p-bk-api.saas.ebs.bbchain.network","description":"Generated server url"}],"paths":{"/v1/apps/{app-id}/deployment":{"patch":{"tags":["app-deploy-web-adapter"],"operationId":"removeAppDeployment","parameters":[{"name":"app-id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppDeployment"}}},"required":true},"responses":{"200":{"description":"OK"}}}}},"components":{"schemas":{"AppDeployment":{"type":"object","properties":{"nodes":{"type":"array","items":{"$ref":"#/components/schemas/AppNodeDeploymentItem"}},"version":{"type":"string"}},"required":["nodes","version"]},"AppNodeDeploymentItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"deploymentName":{"type":"string"},"apiArguments":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentArgument"}},"contractArguments":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentArgument"}}},"required":["id"]},"DeploymentArgument":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}} ``` ## GET /v1/apps/{app-id}/nodes > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://apps-p-bk-api.saas.ebs.bbchain.network","description":"Generated server url"}],"paths":{"/v1/apps/{app-id}/nodes":{"get":{"tags":["app-deploy-web-adapter"],"operationId":"getAppNodes","parameters":[{"name":"app-id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"nodeId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"customer","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"version","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"orderBy","in":"query","required":false,"schema":{"type":"string","default":"id"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","default":"ASC"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorDappsNodePageDTO"}}}}}}}},"components":{"schemas":{"CorDappsNodePageDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CorDappNodesDTO"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}}},"CorDappNodesDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"node":{"$ref":"#/components/schemas/CorDappNodesDTONode"},"previousVersion":{"type":"string"},"version":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["RUNNING","INSTALLING","REMOVING","INSTALLED","NOT_INSTALLED","ERROR","CREATED","CREATING"]}}},"CorDappNodesDTONode":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"integer","format":"int64"}}},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}} ``` ## GET /v1/apps/{app-id}/nodes/{node-id} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://apps-p-bk-api.saas.ebs.bbchain.network","description":"Generated server url"}],"paths":{"/v1/apps/{app-id}/nodes/{node-id}":{"get":{"tags":["app-deploy-web-adapter"],"operationId":"getAppVersionLog","parameters":[{"name":"app-id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"node-id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"version","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorDappsVersionLogDTO"}}}}}}}},"components":{"schemas":{"CorDappsVersionLogDTO":{"type":"object","properties":{"log":{"type":"string"}}}}}} ``` ## GET /v1/apps/deployments/statistics > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://apps-p-bk-api.saas.ebs.bbchain.network","description":"Generated server url"}],"paths":{"/v1/apps/deployments/statistics":{"get":{"tags":["app-deploy-web-adapter"],"operationId":"getDeploymentsStatistics","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentStatisticsDTO"}}}}}}}},"components":{"schemas":{"DeploymentStatisticsDTO":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"byKind":{"type":"array","items":{"$ref":"#/components/schemas/KindCountDTO"}}},"required":["byKind","total"]},"KindCountDTO":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/JsonNullableKindEnum"},"count":{"type":"integer","format":"int64"}},"required":["count","kind"]},"JsonNullableKindEnum":{"type":"object","properties":{"present":{"type":"boolean"}}}}}} ``` ## GET /v1/apps/deployment > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://apps-p-bk-api.saas.ebs.bbchain.network","description":"Generated server url"}],"paths":{"/v1/apps/deployment":{"get":{"tags":["app-deploy-web-adapter"],"operationId":"getDeployments","parameters":[{"name":"networkId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"orderBy","in":"query","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","required":false,"schema":{"type":"string"}},{"name":"appId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"versionId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"versionKind","in":"query","required":false,"schema":{"type":"string"}},{"name":"deploymentId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"appName","in":"query","required":false,"schema":{"type":"string"}},{"name":"deploymentName","in":"query","required":false,"schema":{"type":"string"}},{"name":"appDeveloper","in":"query","required":false,"schema":{"type":"string"}},{"name":"version","in":"query","required":false,"schema":{"type":"string"}},{"name":"availableProtocols","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"nodeId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"customer","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentPage"}}}}}}}},"components":{"schemas":{"DeploymentPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Deployment"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}}},"Deployment":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"app":{"$ref":"#/components/schemas/DeployedApp"},"name":{"type":"string"},"version":{"$ref":"#/components/schemas/DeployedVersion"},"address":{"type":"string"},"node":{"$ref":"#/components/schemas/DeployedNode"},"network":{"$ref":"#/components/schemas/DeployedNetwork"},"status":{"type":"string","enum":["INSTALLED","INSTALLING","UNINSTALING","ERROR"]},"createdBy":{"type":"integer","format":"int64"}}},"DeployedApp":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"developer":{"type":"string"},"createdBy":{"type":"integer","format":"int64"}}},"DeployedVersion":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"kind":{"type":"string"}}},"DeployedNode":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"DeployedNetwork":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"protocol":{"type":"string"},"protocolId":{"type":"integer","format":"int64"}}},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}} ```