| Method and Path | Description | ||
|---|---|---|---|
| GET | / | Get all services. |
|
| GET | //:name | ||
| GET | //:name/uri | Get the URI of given service. |
|
| https://app.apibuilder.io/nccloud/common/latest/service.json |
The current state of a single service.
| Name | Value | Description |
|---|---|---|
| unavailable | unavailable | This service is currently not deployed. |
| available | available | This service is deployed and reachable. |
| error | error | This service is deployed but not reachable due to an error. |
Indicates where a service is reachable.
| Name | Value | Description |
|---|---|---|
| public | public | This service is publicly reachable. |
| internal | internal | This service only reachable internally in the cluster. |
Interfaces: None
A single available service.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| name | string | Yes | - |
|
| version | string | Yes | - |
|
| state | service_state | Yes | - |
|
| type | service_type | Yes | public |
|
| uri | string | Yes | - | URI under which this service is deployed.
|
| title | string | No | - | A human-readable title of the service.
|
| description | string | No | - | A human-readable description of the service.
|
Interfaces: None
A service has been undeployed is not reachable anymore.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| name | string | Yes | - | Name of the service that has been undeployed.
|
| timestamp | date-time-iso8601 | Yes | - |
|
Interfaces: None
A service has been newly deployed or updated.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| service | service | Yes | - |
|
| timestamp | date-time-iso8601 | Yes | - |
|
Interfaces: None
| Type | Discriminator Value | Example Json | Description |
|---|---|---|---|
| service_upserted_event | service_upserted_event | Minimal | Full |
|
| service_deleted_event | service_deleted_event | Minimal | Full |
|
