All URIs are relative to https://api.lab5e.com
| Method | HTTP request | Description |
|---|---|---|
| create_gateway | POST /span/collections/{collectionId}/gateways | Create gateway |
| delete_gateway | DELETE /span/collections/{collectionId}/gateways/{gatewayId} | Delete gateway |
| gateway_certificates | GET /span/collections/{collectionId}/gateways/{gatewayId}/certs | Get issued certificate(s) for gateway |
| list_gateways | GET /span/collections/{collectionId}/gateways | List gateways |
| retrieve_gateway | GET /span/collections/{collectionId}/gateways/{gatewayId} | Retrieve gateway |
| retrieve_gateway_stats | GET /span/collections/{collectionId}/gateways/{gatewayId}/stats | Retrieve gateway statistics |
| update_gateway | PATCH /span/collections/{existingCollectionId}/gateways/{gatewayId} | Update gateway |
crate::models::Gateway create_gateway(collection_id, body) Create gateway
Create a new gateway.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| collection_id | String | [required] | ||
| body | CreateGatewayBody | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::Gateway delete_gateway(collection_id, gateway_id) Delete gateway
Remove a gateway from Span.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| collection_id | String | [required] | ||
| gateway_id | String | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::GatewayCertificateResponse gateway_certificates(collection_id, gateway_id) Get issued certificate(s) for gateway
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| collection_id | String | [required] | ||
| gateway_id | String | [required] |
crate::models::GatewayCertificateResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::ListGatewayResponse list_gateways(collection_id) List gateways
List the user's gatways, including built-in gateways.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| collection_id | String | [required] |
crate::models::ListGatewayResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::Gateway retrieve_gateway(collection_id, gateway_id) Retrieve gateway
Get gateway information
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| collection_id | String | [required] | ||
| gateway_id | String | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::GatewayStats retrieve_gateway_stats(collection_id, gateway_id) Retrieve gateway statistics
Get statistics for gateway
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| collection_id | String | [required] | ||
| gateway_id | String | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::Gateway update_gateway(existing_collection_id, gateway_id, body) Update gateway
Update configuration for a gateway. If you want to remove or move a gateway from the collection the devices in the collection must not have any gateway configuration. The certificates for the gateway are unchanged when the gateway is moved.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| existing_collection_id | String | [required] | ||
| gateway_id | String | [required] | ||
| body | UpdateGatewayBody | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]