> 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/network/models.md).

# Models

## The Error object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error status summary for the executed command."},"code":{"type":"string","description":"# `network.{field}.invalid` field is non compliant # `auth.invalid` Invalid credentials sent to the server. # `auth.verifyEmail` User did not verified their email. # `auth.mustChangePassword` User must change password.         # `user.emailAlreadyUsed` Email already exists. # `auth.forbidden` Forbidden access # `internal.unexpected` Unexpected error from server ","enum":["auth.invalid","auth.verifyEmail","auth.unauthorized","auth.forbidden","auth.expired","auth.blocked","auth.emailDomainBlocked","auth.mustChangePassword","auth.invalidPhoneVerificationCode","auth.passwordNotValid","auth.unableToUpdatePassword","user.notFound","user.created","user.notCreated","user.emailAlreadyExists","userHasRoleInClient","notaryNotFound","notaryPublishDateTooEarly","notaryOrganizationNameConflict","notaryIsCreating","network.notFound","network.alias.invalid","network.name.invalid","network.domain.invalid","network.organizationLegalName.invalid","network.city.invalid","network.country.invalid","network.nodeDomain.invalid","network.tenant.invalid","networkUserDoesNotHavePermissionOnNode","networkUserDoesNotHaveOperatorPermissionOnNode","networkUserDoesNotHavePermissionOnNotary","networkUserDoesNotHaveOperatorPermissionOnNotary","node.notFound","nodeOrganizationNameConflict","cordappVersionShouldBeDisabled","cordappShouldNotHaveVersions","shouldWaitPendingFlagday","internal.unexpected","field.required","field.invalid","field.size","field.pattern","illegalStatus","badRequest","timeConstraint","reachedMaxNetworks","reachedSubscriptionLimit","userReachedSubscriptionLimit","subscriptionTenantNotFoundBecauseNetworkNotFound","subscriptionNodeNameConflict","featureDisabled","adminActionNotFound","adminActionExists","adminActionNotCreated","adminActionDuplicated","adminCloudProviderNotFound","adminCloudProviderExists","adminCloudProviderNotCreated","adminProtocolNotFound","adminProtocolExists","adminProtocolNotCreated","adminPipelineServiceNotFound","adminPipelineServiceExists","adminPipelineServiceNotCreated","adminTenantNotFound","adminTenantExists","adminTenantNotCreated","adminPipelineNotFound","adminPipelineExists","adminPipelineNotCreated","adminComponentNotFound","adminComponentExists","adminComponentNotCreated","adminTenantSettingsNotFound","adminTenantSettingsExists","adminTenantSettingsNotCreated","adminTenantProtocolNotFound","adminTenantProtocolExists","adminTenantProtocolNotCreated","adminFeatureToggleNotFound","adminFeatureToggleExists","adminUserNotFound","adminNetworkNotFound","adminNetworkExists","adminNodeNotFound","adminNodeExists","adminNotaryNotFound","adminNotaryExists","adminPipelineActionDuplicated","adminAppNotFound","adminAppVersionNotFound","adminAppInstallationNotFound","adminComponentTypeNotFound","adminComponentTypeExists","adminBaseDltNotFound","adminBaseDltExists","adminBaseDltNotCreated","adminIdentityProviderNotFound","adminIdentityProviderExists","adminIdentityProviderNotCreated","adminNodeFeatureNotFound","adminNodeFeatureExists","adminNodeFeatureNotCreated","adminSpecializedModuleNotFound","adminSpecializedModuleExists"]}}}}}}
```

## The NetworkDescriptionUpdateDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkDescriptionUpdateDTO":{"type":"object","properties":{"alias":{"type":"string","description":"An alias for the network being created. Used to be easily recognized by the user."},"tenant":{"$ref":"#/components/schemas/TenantDTO"},"protocol":{"type":"integer","format":"int64"},"isPublic":{"type":"boolean"},"command":{"type":"string","enum":["STOP","START","RESTART","PURGE"]}},"required":["alias"]},"TenantDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","description":"The name of the tenant.","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","description":"Last time the tenant was updated.","readOnly":true},"location":{"$ref":"#/components/schemas/TenantLocationDTO"},"tier":{"$ref":"#/components/schemas/TenantTierDTO"}}},"TenantLocationDTO":{"type":"object","properties":{"name":{"type":"string","description":"The region where the cluster is deployed."},"coordinates":{"$ref":"#/components/schemas/TenantLocationDTOCoordinates"}},"required":["coordinates","name"]},"TenantLocationDTOCoordinates":{"type":"object","properties":{"longitude":{"type":"string"},"latitude":{"type":"string"}},"required":["latitude","longitude"]},"TenantTierDTO":{"type":"object","properties":{"name":{"type":"string","description":"User friendly name for cluster sizing."},"description":{"type":"string","description":"Info about the tenant"},"public":{"type":"boolean","description":"Defines if it is a public tenant or not"},"sizing":{"$ref":"#/components/schemas/TenantHardwareSizeDTO"}}},"TenantHardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus.","readOnly":true},"ram":{"type":"integer","format":"int64","description":"Size of RAM.","readOnly":true}},"required":["ram","vcpu"]}}}}
```

## The TenantDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"TenantDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","description":"The name of the tenant.","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","description":"Last time the tenant was updated.","readOnly":true},"location":{"$ref":"#/components/schemas/TenantLocationDTO"},"tier":{"$ref":"#/components/schemas/TenantTierDTO"}}},"TenantLocationDTO":{"type":"object","properties":{"name":{"type":"string","description":"The region where the cluster is deployed."},"coordinates":{"$ref":"#/components/schemas/TenantLocationDTOCoordinates"}},"required":["coordinates","name"]},"TenantLocationDTOCoordinates":{"type":"object","properties":{"longitude":{"type":"string"},"latitude":{"type":"string"}},"required":["latitude","longitude"]},"TenantTierDTO":{"type":"object","properties":{"name":{"type":"string","description":"User friendly name for cluster sizing."},"description":{"type":"string","description":"Info about the tenant"},"public":{"type":"boolean","description":"Defines if it is a public tenant or not"},"sizing":{"$ref":"#/components/schemas/TenantHardwareSizeDTO"}}},"TenantHardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus.","readOnly":true},"ram":{"type":"integer","format":"int64","description":"Size of RAM.","readOnly":true}},"required":["ram","vcpu"]}}}}
```

## The TenantHardwareSizeDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"TenantHardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus.","readOnly":true},"ram":{"type":"integer","format":"int64","description":"Size of RAM.","readOnly":true}},"required":["ram","vcpu"]}}}}
```

## The TenantLocationDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"TenantLocationDTO":{"type":"object","properties":{"name":{"type":"string","description":"The region where the cluster is deployed."},"coordinates":{"$ref":"#/components/schemas/TenantLocationDTOCoordinates"}},"required":["coordinates","name"]},"TenantLocationDTOCoordinates":{"type":"object","properties":{"longitude":{"type":"string"},"latitude":{"type":"string"}},"required":["latitude","longitude"]}}}}
```

## The TenantLocationDTOCoordinates object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"TenantLocationDTOCoordinates":{"type":"object","properties":{"longitude":{"type":"string"},"latitude":{"type":"string"}},"required":["latitude","longitude"]}}}}
```

## The TenantTierDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"TenantTierDTO":{"type":"object","properties":{"name":{"type":"string","description":"User friendly name for cluster sizing."},"description":{"type":"string","description":"Info about the tenant"},"public":{"type":"boolean","description":"Defines if it is a public tenant or not"},"sizing":{"$ref":"#/components/schemas/TenantHardwareSizeDTO"}}},"TenantHardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus.","readOnly":true},"ram":{"type":"integer","format":"int64","description":"Size of RAM.","readOnly":true}},"required":["ram","vcpu"]}}}}
```

## The LegalNameDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"LegalNameDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"}},"required":["city","country","organization"]}}}}
```

## The ComponentIdDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]}}}}
```

## The ExternalIntegrationDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"ExternalIntegrationDTO":{"type":"object","properties":{"source":{"type":"string","enum":["EBS","ON_PREMISE"]},"protocol":{"type":"string","enum":["BESU","DB"]},"nodeId":{"type":"integer","format":"int64"},"jdbcUrl":{"type":"string"},"nodeUrl":{"type":"string"}},"required":["protocol","source"]}}}}
```

## The PtahExplorerDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahExplorerDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"component":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["component","currentStatus","id","identifier","name","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]}}}}
```

## The PtahProofDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahProofDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"blockchainIntegration":{"$ref":"#/components/schemas/ExternalIntegrationDTO"},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["blockchainIntegration","currentStatus","explorer","governedBy","id","identifier","integratedBy","name","network","organization","tenant","type"]},"ExternalIntegrationDTO":{"type":"object","properties":{"source":{"type":"string","enum":["EBS","ON_PREMISE"]},"protocol":{"type":"string","enum":["BESU","DB"]},"nodeId":{"type":"integer","format":"int64"},"jdbcUrl":{"type":"string"},"nodeUrl":{"type":"string"}},"required":["protocol","source"]},"PtahExplorerDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"component":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["component","currentStatus","id","identifier","name","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]}}}}
```

## The PtahProofCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahProofCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"User Friendly Name"},"network":{"type":"integer","format":"int64"},"tenant":{"type":"integer","format":"int64"},"organization":{"type":"integer","format":"int64"},"blockchainIntegration":{"$ref":"#/components/schemas/ExternalIntegrationDTO"}},"required":["blockchainIntegration","name","network","organization","tenant"]},"ExternalIntegrationDTO":{"type":"object","properties":{"source":{"type":"string","enum":["EBS","ON_PREMISE"]},"protocol":{"type":"string","enum":["BESU","DB"]},"nodeId":{"type":"integer","format":"int64"},"jdbcUrl":{"type":"string"},"nodeUrl":{"type":"string"}},"required":["protocol","source"]}}}}
```

## The PtahNodeDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahNodeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"identity":{"$ref":"#/components/schemas/ComponentIdDTO"},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","explorer","governedBy","id","identifier","identity","integratedBy","name","network","organization","tenant","type"]},"PtahExplorerDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"component":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["component","currentStatus","id","identifier","name","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]}}}}
```

## The EbsComponentCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"EbsComponentCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"User Friendly Name"},"network":{"type":"integer","format":"int64"},"tenant":{"type":"integer","format":"int64"},"organization":{"type":"integer","format":"int64"}},"required":["name","network","organization","tenant"]}}}}
```

## The PtahNodeCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahNodeCreateRequest":{"type":"object","properties":{"component":{"$ref":"#/components/schemas/EbsComponentCreateRequest"},"identity":{"type":"integer","format":"int64"}},"required":["component","identity"]},"EbsComponentCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"User Friendly Name"},"network":{"type":"integer","format":"int64"},"tenant":{"type":"integer","format":"int64"},"organization":{"type":"integer","format":"int64"}},"required":["name","network","organization","tenant"]}}}}
```

## The PtahBalanceNodeDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahBalanceNodeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"blockchainIntegration":{"$ref":"#/components/schemas/ExternalIntegrationDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","explorer","governedBy","id","identifier","integratedBy","name","network","organization","tenant","type"]},"PtahExplorerDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"component":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["component","currentStatus","id","identifier","name","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]},"ExternalIntegrationDTO":{"type":"object","properties":{"source":{"type":"string","enum":["EBS","ON_PREMISE"]},"protocol":{"type":"string","enum":["BESU","DB"]},"nodeId":{"type":"integer","format":"int64"},"jdbcUrl":{"type":"string"},"nodeUrl":{"type":"string"}},"required":["protocol","source"]}}}}
```

## The PtahDispatcherNodeDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahDispatcherNodeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","description":"User Friendly Name"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","explorer","governedBy","id","identifier","integratedBy","name","organization","tenant","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]},"PtahExplorerDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"component":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["component","currentStatus","id","identifier","name","type"]}}}}
```

## The PtahGovernanceDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahGovernanceDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"integrationLayer":{"$ref":"#/components/schemas/PtahIntegrationLayerDTO"},"balanceNodes":{"type":"array","items":{"$ref":"#/components/schemas/PtahBalanceNodeDTO"}},"proofs":{"type":"array","items":{"$ref":"#/components/schemas/PtahProofDTO"}},"matchers":{"type":"array","items":{"$ref":"#/components/schemas/PtahMatcherNodeDTO"}},"dispatchers":{"type":"array","items":{"$ref":"#/components/schemas/PtahDispatcherNodeDTO"}},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"identities":{"type":"array","items":{"$ref":"#/components/schemas/PtahIdentityDTO"}},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["balanceNodes","currentStatus","dispatchers","id","identifier","integrationLayer","matchers","name","network","organization","proofs","tenant","type"]},"PtahIntegrationLayerDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","governedBy","id","identifier","name","network","organization","tenant","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]},"PtahBalanceNodeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"blockchainIntegration":{"$ref":"#/components/schemas/ExternalIntegrationDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","explorer","governedBy","id","identifier","integratedBy","name","network","organization","tenant","type"]},"PtahExplorerDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"component":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["component","currentStatus","id","identifier","name","type"]},"ExternalIntegrationDTO":{"type":"object","properties":{"source":{"type":"string","enum":["EBS","ON_PREMISE"]},"protocol":{"type":"string","enum":["BESU","DB"]},"nodeId":{"type":"integer","format":"int64"},"jdbcUrl":{"type":"string"},"nodeUrl":{"type":"string"}},"required":["protocol","source"]},"PtahProofDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"blockchainIntegration":{"$ref":"#/components/schemas/ExternalIntegrationDTO"},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["blockchainIntegration","currentStatus","explorer","governedBy","id","identifier","integratedBy","name","network","organization","tenant","type"]},"PtahMatcherNodeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","explorer","governedBy","id","identifier","integratedBy","name","network","organization","tenant","type"]},"PtahDispatcherNodeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","description":"User Friendly Name"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","explorer","governedBy","id","identifier","integratedBy","name","organization","tenant","type"]},"PtahIdentityDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","governedBy","id","identifier","integratedBy","name","network","organization","tenant","type"]}}}}
```

## The PtahIdentityDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahIdentityDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","governedBy","id","identifier","integratedBy","name","network","organization","tenant","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]}}}}
```

## The PtahIntegrationLayerDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahIntegrationLayerDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","governedBy","id","identifier","name","network","organization","tenant","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]}}}}
```

## The PtahMatcherNodeDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahMatcherNodeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","explorer","governedBy","id","identifier","integratedBy","name","network","organization","tenant","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]},"PtahExplorerDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"component":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["component","currentStatus","id","identifier","name","type"]}}}}
```

## The PtahNetworkDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahNetworkDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"governance":{"$ref":"#/components/schemas/PtahGovernanceDTO"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","governance","id","name","organization","tenant"]},"PtahGovernanceDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"integrationLayer":{"$ref":"#/components/schemas/PtahIntegrationLayerDTO"},"balanceNodes":{"type":"array","items":{"$ref":"#/components/schemas/PtahBalanceNodeDTO"}},"proofs":{"type":"array","items":{"$ref":"#/components/schemas/PtahProofDTO"}},"matchers":{"type":"array","items":{"$ref":"#/components/schemas/PtahMatcherNodeDTO"}},"dispatchers":{"type":"array","items":{"$ref":"#/components/schemas/PtahDispatcherNodeDTO"}},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"identities":{"type":"array","items":{"$ref":"#/components/schemas/PtahIdentityDTO"}},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["balanceNodes","currentStatus","dispatchers","id","identifier","integrationLayer","matchers","name","network","organization","proofs","tenant","type"]},"PtahIntegrationLayerDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","governedBy","id","identifier","name","network","organization","tenant","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]},"PtahBalanceNodeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"blockchainIntegration":{"$ref":"#/components/schemas/ExternalIntegrationDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","explorer","governedBy","id","identifier","integratedBy","name","network","organization","tenant","type"]},"PtahExplorerDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"component":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["component","currentStatus","id","identifier","name","type"]},"ExternalIntegrationDTO":{"type":"object","properties":{"source":{"type":"string","enum":["EBS","ON_PREMISE"]},"protocol":{"type":"string","enum":["BESU","DB"]},"nodeId":{"type":"integer","format":"int64"},"jdbcUrl":{"type":"string"},"nodeUrl":{"type":"string"}},"required":["protocol","source"]},"PtahProofDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"blockchainIntegration":{"$ref":"#/components/schemas/ExternalIntegrationDTO"},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["blockchainIntegration","currentStatus","explorer","governedBy","id","identifier","integratedBy","name","network","organization","tenant","type"]},"PtahMatcherNodeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","explorer","governedBy","id","identifier","integratedBy","name","network","organization","tenant","type"]},"PtahDispatcherNodeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","description":"User Friendly Name"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","explorer","governedBy","id","identifier","integratedBy","name","organization","tenant","type"]},"PtahIdentityDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","governedBy","id","identifier","integratedBy","name","network","organization","tenant","type"]}}}}
```

## The PtahNetworkCreateRequestDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahNetworkCreateRequestDTO":{"type":"object","properties":{"name":{"type":"string"},"firstIdentity":{"type":"string"},"tenant":{"type":"integer","format":"int64"},"organization":{"type":"integer","format":"int64"},"balanceBlockchainIntegration":{"$ref":"#/components/schemas/ExternalIntegrationDTO"},"proofBlockchainIntegration":{"$ref":"#/components/schemas/ExternalIntegrationDTO"},"governance":{"type":"string","description":"User Friendly Name."},"integrationLayer":{"type":"string","description":"User Friendly Name."},"balance":{"type":"string","description":"User Friendly Name."},"dispatcher":{"type":"string","description":"User Friendly Name"},"matcher":{"type":"string","description":"User Friendly Name"},"proof":{"type":"string","description":"User Friendly Name"}},"required":["balanceBlockchainIntegration","firstIdentity","name","organization","proofBlockchainIntegration","tenant"]},"ExternalIntegrationDTO":{"type":"object","properties":{"source":{"type":"string","enum":["EBS","ON_PREMISE"]},"protocol":{"type":"string","enum":["BESU","DB"]},"nodeId":{"type":"integer","format":"int64"},"jdbcUrl":{"type":"string"},"nodeUrl":{"type":"string"}},"required":["protocol","source"]}}}}
```

## The PtahExecutorDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahExecutorDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"identity":{"$ref":"#/components/schemas/ComponentIdDTO"},"explorer":{"$ref":"#/components/schemas/PtahExplorerDTO"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","explorer","governedBy","id","identifier","identity","integratedBy","name","network","organization","tenant","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]},"PtahExplorerDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"component":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"endpoint":{"type":"string","format":"uri"},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["component","currentStatus","id","identifier","name","type"]}}}}
```

## The PtahBalanceCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahBalanceCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"User Friendly Name"},"network":{"type":"integer","format":"int64"},"tenant":{"type":"integer","format":"int64"},"organization":{"type":"integer","format":"int64"},"blockchainIntegration":{"$ref":"#/components/schemas/ExternalIntegrationDTO"}},"required":["blockchainIntegration","name","network","organization","tenant"]},"ExternalIntegrationDTO":{"type":"object","properties":{"source":{"type":"string","enum":["EBS","ON_PREMISE"]},"protocol":{"type":"string","enum":["BESU","DB"]},"nodeId":{"type":"integer","format":"int64"},"jdbcUrl":{"type":"string"},"nodeUrl":{"type":"string"}},"required":["protocol","source"]}}}}
```

## The NetworkDescription object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkDescription":{"type":"object","properties":{"alias":{"type":"string","description":"An alias for the network being created. Used to be easily recognized by the user."},"protocol":{"$ref":"#/components/schemas/NetworkDescriptionBaseProtocol"},"customer":{"type":"integer","format":"int64"},"tenant":{"$ref":"#/components/schemas/TenantDTO"},"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"},"id":{"type":"integer","format":"int64","readOnly":true},"status":{"type":"string","enum":["STARTING","RUNNING","CREATING","STOPPING","STOPPED","PENDING_UPDATE","DELETING","ERROR","PURGING","RESTARTING"]},"name":{"type":"string","description":"The name of the network as it will be built in the cloud. It must: be lowercase; not contain special characters; not be longer than X characters. TODO: define the max length properly","pattern":"^([a-z0-9]+)(\\-[a-z0-9]+)*"},"explorer":{"type":"string","readOnly":true},"internalDomain":{"type":"string","readOnly":true},"isPublic":{"type":"boolean"},"nodeNames":{"type":"array","description":"List of node names used in network creation.","items":{"type":"string"}},"payer":{"type":"string","format":"uuid","readOnly":true},"creationDate":{"type":"string","format":"date-time","readOnly":true},"createdBy":{"type":"string","description":"User or entity that created the network.","readOnly":true},"participants":{"type":"integer","format":"int64","readOnly":true},"nodes":{"type":"integer","format":"int64","readOnly":true},"platformVersion":{"type":"integer","format":"int32","readOnly":true},"isExternal":{"type":"boolean","readOnly":true},"hasGenesis":{"type":"boolean","readOnly":true},"sandboxConfiguration":{"$ref":"#/components/schemas/SandboxConfiguration"}},"required":["alias","city","country","customer","organization","protocol","tenant"]},"NetworkDescriptionBaseProtocol":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","readOnly":true},"tag":{"type":"string","readOnly":true}},"required":["id"]},"TenantDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","description":"The name of the tenant.","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","description":"Last time the tenant was updated.","readOnly":true},"location":{"$ref":"#/components/schemas/TenantLocationDTO"},"tier":{"$ref":"#/components/schemas/TenantTierDTO"}}},"TenantLocationDTO":{"type":"object","properties":{"name":{"type":"string","description":"The region where the cluster is deployed."},"coordinates":{"$ref":"#/components/schemas/TenantLocationDTOCoordinates"}},"required":["coordinates","name"]},"TenantLocationDTOCoordinates":{"type":"object","properties":{"longitude":{"type":"string"},"latitude":{"type":"string"}},"required":["latitude","longitude"]},"TenantTierDTO":{"type":"object","properties":{"name":{"type":"string","description":"User friendly name for cluster sizing."},"description":{"type":"string","description":"Info about the tenant"},"public":{"type":"boolean","description":"Defines if it is a public tenant or not"},"sizing":{"$ref":"#/components/schemas/TenantHardwareSizeDTO"}}},"TenantHardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus.","readOnly":true},"ram":{"type":"integer","format":"int64","description":"Size of RAM.","readOnly":true}},"required":["ram","vcpu"]},"SandboxConfiguration":{"type":"object","properties":{"network":{"type":"integer","format":"int64"},"mainUrl":{"type":"string"},"available":{"type":"boolean"},"id":{"type":"integer","format":"int64","readOnly":true}},"required":["available","mainUrl","network"]}}}}
```

## The NetworkDescriptionBaseProtocol object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkDescriptionBaseProtocol":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","readOnly":true},"tag":{"type":"string","readOnly":true}},"required":["id"]}}}}
```

## The SandboxConfiguration object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"SandboxConfiguration":{"type":"object","properties":{"network":{"type":"integer","format":"int64"},"mainUrl":{"type":"string"},"available":{"type":"boolean"},"id":{"type":"integer","format":"int64","readOnly":true}},"required":["available","mainUrl","network"]}}}}
```

## The EbsComponentUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"EbsComponentUpdateRequest":{"type":"object","properties":{"name":{"type":"string","description":"User Friendly Name"},"operation":{"type":"string","enum":["RENAME","START","STOP","RESTART"]}}}}}}
```

## The CommmandRequest object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"CommmandRequest":{"type":"object","properties":{"command":{"type":"string","enum":["STOP","START","RESTART","PURGE"]}},"required":["command"]}}}}
```

## The PageMetadata object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## The PtahComponentPageDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahComponentPageDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PtahComponentPageItemDTO"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}},"required":["data","metadata"]},"PtahComponentPageItemDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","governedBy","id","integratedBy","name","organization","tenant"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## The PtahComponentPageItemDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahComponentPageItemDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","governedBy","id","integratedBy","name","organization","tenant"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]}}}}
```

## The PtahNetworkPageDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahNetworkPageDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PtahNetworkPageItemDTO"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}},"required":["data","metadata"]},"PtahNetworkPageItemDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"expectedStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"identities":{"type":"integer","format":"int64"},"participants":{"type":"integer","format":"int64"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","expectedStatus","id","identities","name","organization","participants","tenant"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## The PtahNetworkPageItemDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahNetworkPageItemDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"expectedStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"identities":{"type":"integer","format":"int64"},"participants":{"type":"integer","format":"int64"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","expectedStatus","id","identities","name","organization","participants","tenant"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]}}}}
```

## The PtahIdentityPageDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahIdentityPageDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PtahIdentityPageItemDTO"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}},"required":["data","metadata"]},"PtahIdentityPageItemDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"expectedStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"nodeCount":{"type":"integer","format":"int64"},"executorCount":{"type":"integer","format":"int64"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","executorCount","expectedStatus","governedBy","id","identifier","integratedBy","name","nodeCount","organization","tenant"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## The PtahIdentityPageItemDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"PtahIdentityPageItemDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"identifier":{"type":"string","description":"Name generated from the user friendly name and used to create the component deployment"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"expectedStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"governedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"integratedBy":{"$ref":"#/components/schemas/ComponentIdDTO"},"nodeCount":{"type":"integer","format":"int64"},"executorCount":{"type":"integer","format":"int64"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"}},"required":["currentStatus","executorCount","expectedStatus","governedBy","id","identifier","integratedBy","name","nodeCount","organization","tenant"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]}}}}
```

## The EbsComponentPageDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"EbsComponentPageDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EbsComponentPageItemDTO"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}},"required":["data","metadata"]},"EbsComponentPageItemDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"type":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"},"resourcePath":{"type":"string"},"resourceIcon":{"type":"string"}},"required":["currentStatus","id","name","network","organization","tenant","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## The EbsComponentPageItemDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"EbsComponentPageItemDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"currentStatus":{"type":"string","enum":["CREATING","RUNNING","UPDATING","STOPPING","STOPPED","RESTARTING","STARTING","DELETING","UNKNOWN","ERROR"]},"network":{"$ref":"#/components/schemas/ComponentIdDTO"},"tenant":{"$ref":"#/components/schemas/ComponentIdDTO"},"organization":{"$ref":"#/components/schemas/ComponentIdDTO"},"type":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"subscription":{"$ref":"#/components/schemas/ComponentIdDTO"},"resourcePath":{"type":"string"},"resourceIcon":{"type":"string"}},"required":["currentStatus","id","name","network","organization","tenant","type"]},"ComponentIdDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]}}}}
```

## The ComponentStatisticsDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"ComponentStatisticsDTO":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"Total number of PTAH components"},"protocol":{"type":"string","description":"Protocol type (all components are PTAH)","enum":["PTAH"]}},"required":["protocol","total"]}}}}
```

## The NetworkTypeDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkTypeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"dlt":{"type":"string"},"vendor":{"type":"string"},"version":{"type":"string"},"openSource":{"type":"boolean"},"tag":{"type":"string"},"dltType":{"type":"string"}}}}}}
```

## The NetworkTypePageDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkTypePageDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkTypeDTO"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}}},"NetworkTypeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"dlt":{"type":"string"},"vendor":{"type":"string"},"version":{"type":"string"},"openSource":{"type":"boolean"},"tag":{"type":"string"},"dltType":{"type":"string"}}},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## The NetworkPage object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkDescription"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}}},"NetworkDescription":{"type":"object","properties":{"alias":{"type":"string","description":"An alias for the network being created. Used to be easily recognized by the user."},"protocol":{"$ref":"#/components/schemas/NetworkDescriptionBaseProtocol"},"customer":{"type":"integer","format":"int64"},"tenant":{"$ref":"#/components/schemas/TenantDTO"},"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"},"id":{"type":"integer","format":"int64","readOnly":true},"status":{"type":"string","enum":["STARTING","RUNNING","CREATING","STOPPING","STOPPED","PENDING_UPDATE","DELETING","ERROR","PURGING","RESTARTING"]},"name":{"type":"string","description":"The name of the network as it will be built in the cloud. It must: be lowercase; not contain special characters; not be longer than X characters. TODO: define the max length properly","pattern":"^([a-z0-9]+)(\\-[a-z0-9]+)*"},"explorer":{"type":"string","readOnly":true},"internalDomain":{"type":"string","readOnly":true},"isPublic":{"type":"boolean"},"nodeNames":{"type":"array","description":"List of node names used in network creation.","items":{"type":"string"}},"payer":{"type":"string","format":"uuid","readOnly":true},"creationDate":{"type":"string","format":"date-time","readOnly":true},"createdBy":{"type":"string","description":"User or entity that created the network.","readOnly":true},"participants":{"type":"integer","format":"int64","readOnly":true},"nodes":{"type":"integer","format":"int64","readOnly":true},"platformVersion":{"type":"integer","format":"int32","readOnly":true},"isExternal":{"type":"boolean","readOnly":true},"hasGenesis":{"type":"boolean","readOnly":true},"sandboxConfiguration":{"$ref":"#/components/schemas/SandboxConfiguration"}},"required":["alias","city","country","customer","organization","protocol","tenant"]},"NetworkDescriptionBaseProtocol":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","readOnly":true},"tag":{"type":"string","readOnly":true}},"required":["id"]},"TenantDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","description":"The name of the tenant.","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","description":"Last time the tenant was updated.","readOnly":true},"location":{"$ref":"#/components/schemas/TenantLocationDTO"},"tier":{"$ref":"#/components/schemas/TenantTierDTO"}}},"TenantLocationDTO":{"type":"object","properties":{"name":{"type":"string","description":"The region where the cluster is deployed."},"coordinates":{"$ref":"#/components/schemas/TenantLocationDTOCoordinates"}},"required":["coordinates","name"]},"TenantLocationDTOCoordinates":{"type":"object","properties":{"longitude":{"type":"string"},"latitude":{"type":"string"}},"required":["latitude","longitude"]},"TenantTierDTO":{"type":"object","properties":{"name":{"type":"string","description":"User friendly name for cluster sizing."},"description":{"type":"string","description":"Info about the tenant"},"public":{"type":"boolean","description":"Defines if it is a public tenant or not"},"sizing":{"$ref":"#/components/schemas/TenantHardwareSizeDTO"}}},"TenantHardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus.","readOnly":true},"ram":{"type":"integer","format":"int64","description":"Size of RAM.","readOnly":true}},"required":["ram","vcpu"]},"SandboxConfiguration":{"type":"object","properties":{"network":{"type":"integer","format":"int64"},"mainUrl":{"type":"string"},"available":{"type":"boolean"},"id":{"type":"integer","format":"int64","readOnly":true}},"required":["available","mainUrl","network"]},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## The NetworkCreationLog object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkCreationLog":{"type":"object","properties":{"stage":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]},"start":{"type":"string","format":"date"},"finish":{"type":"string","format":"date"},"result":{"type":"string","enum":["COMPLETED","WORKING","ERROR"]}}}}}}
```

## The NetworkCreationStatus object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkCreationStatus":{"type":"object","properties":{"stageDetail":{"$ref":"#/components/schemas/NetworkCreationStatusStageDetail"}}},"NetworkCreationStatusStageDetail":{"type":"object","properties":{"currentStage":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]},"orderedStages":{"type":"array","items":{"$ref":"#/components/schemas/NetworkCreationStatusStageDetailOrderedStagesInner"}},"completedStages":{"type":"array","items":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]}},"log":{"type":"array","items":{"$ref":"#/components/schemas/NetworkCreationLog"}}}},"NetworkCreationStatusStageDetailOrderedStagesInner":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"value":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]}}},"NetworkCreationLog":{"type":"object","properties":{"stage":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]},"start":{"type":"string","format":"date"},"finish":{"type":"string","format":"date"},"result":{"type":"string","enum":["COMPLETED","WORKING","ERROR"]}}}}}}
```

## The NetworkCreationStatusStageDetail object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkCreationStatusStageDetail":{"type":"object","properties":{"currentStage":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]},"orderedStages":{"type":"array","items":{"$ref":"#/components/schemas/NetworkCreationStatusStageDetailOrderedStagesInner"}},"completedStages":{"type":"array","items":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]}},"log":{"type":"array","items":{"$ref":"#/components/schemas/NetworkCreationLog"}}}},"NetworkCreationStatusStageDetailOrderedStagesInner":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"value":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]}}},"NetworkCreationLog":{"type":"object","properties":{"stage":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]},"start":{"type":"string","format":"date"},"finish":{"type":"string","format":"date"},"result":{"type":"string","enum":["COMPLETED","WORKING","ERROR"]}}}}}}
```

## The NetworkCreationStatusStageDetailOrderedStagesInner object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkCreationStatusStageDetailOrderedStagesInner":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"value":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]}}}}}}
```

## The NetworkStatus object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkStatus":{"type":"object","properties":{"creation":{"$ref":"#/components/schemas/NetworkCreationStatus"},"currentStatus":{"type":"string","enum":["STARTING","RUNNING","CREATING","STOPPING","STOPPED","PENDING_UPDATE","DELETING","ERROR","PURGING","RESTARTING"]}}},"NetworkCreationStatus":{"type":"object","properties":{"stageDetail":{"$ref":"#/components/schemas/NetworkCreationStatusStageDetail"}}},"NetworkCreationStatusStageDetail":{"type":"object","properties":{"currentStage":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]},"orderedStages":{"type":"array","items":{"$ref":"#/components/schemas/NetworkCreationStatusStageDetailOrderedStagesInner"}},"completedStages":{"type":"array","items":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]}},"log":{"type":"array","items":{"$ref":"#/components/schemas/NetworkCreationLog"}}}},"NetworkCreationStatusStageDetailOrderedStagesInner":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"value":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]}}},"NetworkCreationLog":{"type":"object","properties":{"stage":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]},"start":{"type":"string","format":"date"},"finish":{"type":"string","format":"date"},"result":{"type":"string","enum":["COMPLETED","WORKING","ERROR"]}}}}}}
```

## The NetworkCreationLogPage object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkCreationLogPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkCreationLog"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}}},"NetworkCreationLog":{"type":"object","properties":{"stage":{"type":"string","enum":["NETWORK.DOMAIN","NETWORK.NAMESPACE","NETWORK.CENM.AUTH","NETWORK.CENM.ZONE","NETWORK.CENM.IDMAN","NETWORK.CENM.GATEWAY","NETWORK.CENM.SIGNER","NETWORK.CENM.NETMAP","NETWORK.CORDA.NOTARY","NETWORK.CORDA.NODE","DONE"]},"start":{"type":"string","format":"date"},"finish":{"type":"string","format":"date"},"result":{"type":"string","enum":["COMPLETED","WORKING","ERROR"]}}},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## The NetworkActivity object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkActivity":{"type":"object","properties":{"event":{"type":"string","enum":["login","TODO"]},"logTime":{"type":"string","format":"date"},"description":{"type":"string"}}}}}}
```

## The NetworkActivityPage object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkActivityPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkActivity"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}}},"NetworkActivity":{"type":"object","properties":{"event":{"type":"string","enum":["login","TODO"]},"logTime":{"type":"string","format":"date"},"description":{"type":"string"}}},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## The NetworkStatisticsDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"NetworkStatisticsDTO":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"Total number of networks"},"byStatus":{"type":"array","description":"Count of networks grouped by status","items":{"$ref":"#/components/schemas/StatusCountDTO"}}},"required":["byStatus","total"]},"StatusCountDTO":{"type":"object","properties":{"status":{"type":"string","description":"Network status","enum":["RUNNING","ERROR","STOPPED","CREATING","DELETING","STARTING","STOPPING"]},"count":{"type":"integer","format":"int64","description":"Number of networks with this status"}},"required":["count","status"]}}}}
```

## The StatusCountDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Network API","version":"0.1.0"},"components":{"schemas":{"StatusCountDTO":{"type":"object","properties":{"status":{"type":"string","description":"Network status","enum":["RUNNING","ERROR","STOPPED","CREATING","DELETING","STARTING","STOPPING"]},"count":{"type":"integer","format":"int64","description":"Number of networks with this status"}},"required":["count","status"]}}}}
```