> 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/apps-web-api.md).

# Apps Web Api

## GET /v1/apps/{app-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}":{"get":{"tags":["apps-web-api"],"operationId":"getAppById","parameters":[{"name":"app-id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppDTO"}}}}}}}},"components":{"schemas":{"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"]}}}}
```

## PUT /v1/apps/{app-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}":{"put":{"tags":["apps-web-api"],"operationId":"updateAppById","parameters":[{"name":"app-id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"developer","in":"query","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"showMarketplace","in":"query","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"appIcon":{"type":"string","format":"binary"},"appBanner":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppDTO"}}}}}}}},"components":{"schemas":{"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"]}}}}
```

## DELETE /v1/apps/{app-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}":{"delete":{"tags":["apps-web-api"],"operationId":"deleteApp","parameters":[{"name":"app-id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## GET /v1/apps

>

```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":{"get":{"tags":["apps-web-api"],"operationId":"getApps","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":"appName","in":"query","required":false,"schema":{"type":"string"}},{"name":"appDeveloper","in":"query","required":false,"schema":{"type":"string"}},{"name":"lastVersion","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":"marketplace","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"customer","in":"query","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppPageDTO"}}}}}}}},"components":{"schemas":{"AppPageDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AppPageItemDTO"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}}},"AppPageItemDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"developer":{"type":"string"},"icon":{"type":"string"},"banner":{"type":"string"},"role":{"type":"string","enum":["OWNER","OPERATOR","PARTICIPANT","NONE"]},"availableProtocols":{"type":"array","items":{"$ref":"#/components/schemas/AppProtocol"}},"lastVersion":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"integer","format":"int64"}}},"AppProtocol":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"tag":{"type":"string"},"name":{"type":"string"},"icon":{"type":"string"}},"required":["icon","id","name","tag"]},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## POST /v1/apps

>

```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":{"post":{"tags":["apps-web-api"],"operationId":"createApp","parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string"}},{"name":"developer","in":"query","required":true,"schema":{"type":"string"}},{"name":"description","in":"query","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"showMarketplace","in":"query","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"appIcon":{"type":"string","format":"binary"},"appBanner":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppDTO"}}}}}}}},"components":{"schemas":{"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"]}}}}
```