\GatewaysApi

All URIs are relative to https://api.lab5e.com

Method	HTTP request	Description
CreateGateway	Post /span/collections/{collectionId}/gateways	Create gateway
DeleteGateway	Delete /span/collections/{collectionId}/gateways/{gatewayId}	Delete gateway
GatewayCertificates	Get /span/collections/{collectionId}/gateways/{gatewayId}/certs	Get issued certificate(s) for gateway
ListGateways	Get /span/collections/{collectionId}/gateways	List gateways
RetrieveGateway	Get /span/collections/{collectionId}/gateways/{gatewayId}	Retrieve gateway
RetrieveGatewayStats	Get /span/collections/{collectionId}/gateways/{gatewayId}/stats	Retrieve gateway statistics
UpdateGateway	Patch /span/collections/{existingCollectionId}/gateways/{gatewayId}	Update gateway

CreateGateway

Gateway CreateGateway(ctx, collectionId).Body(body).Execute()

Create gateway

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 
    body := *openapiclient.NewCreateGatewayBody() // CreateGatewayBody | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.GatewaysApi.CreateGateway(context.Background(), collectionId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GatewaysApi.CreateGateway``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateGateway`: Gateway
    fmt.Fprintf(os.Stdout, "Response from `GatewaysApi.CreateGateway`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string

Other Parameters

Other parameters are passed through a pointer to a apiCreateGatewayRequest struct via the builder pattern

Name	Type	Description	Notes

body | CreateGatewayBody | |

Return type

Gateway

Authorization

APIToken

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteGateway

Gateway DeleteGateway(ctx, collectionId, gatewayId).Execute()

Delete gateway

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 
    gatewayId := "gatewayId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.GatewaysApi.DeleteGateway(context.Background(), collectionId, gatewayId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GatewaysApi.DeleteGateway``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteGateway`: Gateway
    fmt.Fprintf(os.Stdout, "Response from `GatewaysApi.DeleteGateway`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string
gatewayId	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteGatewayRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Gateway

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GatewayCertificates

GatewayCertificateResponse GatewayCertificates(ctx, collectionId, gatewayId).Execute()

Get issued certificate(s) for gateway

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 
    gatewayId := "gatewayId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.GatewaysApi.GatewayCertificates(context.Background(), collectionId, gatewayId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GatewaysApi.GatewayCertificates``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GatewayCertificates`: GatewayCertificateResponse
    fmt.Fprintf(os.Stdout, "Response from `GatewaysApi.GatewayCertificates`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string
gatewayId	string

Other Parameters

Other parameters are passed through a pointer to a apiGatewayCertificatesRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

GatewayCertificateResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListGateways

ListGatewayResponse ListGateways(ctx, collectionId).Execute()

List gateways

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.GatewaysApi.ListGateways(context.Background(), collectionId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GatewaysApi.ListGateways``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListGateways`: ListGatewayResponse
    fmt.Fprintf(os.Stdout, "Response from `GatewaysApi.ListGateways`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string

Other Parameters

Other parameters are passed through a pointer to a apiListGatewaysRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ListGatewayResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetrieveGateway

Gateway RetrieveGateway(ctx, collectionId, gatewayId).Execute()

Retrieve gateway

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 
    gatewayId := "gatewayId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.GatewaysApi.RetrieveGateway(context.Background(), collectionId, gatewayId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GatewaysApi.RetrieveGateway``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RetrieveGateway`: Gateway
    fmt.Fprintf(os.Stdout, "Response from `GatewaysApi.RetrieveGateway`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string
gatewayId	string

Other Parameters

Other parameters are passed through a pointer to a apiRetrieveGatewayRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Gateway

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetrieveGatewayStats

GatewayStats RetrieveGatewayStats(ctx, collectionId, gatewayId).Execute()

Retrieve gateway statistics

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 
    gatewayId := "gatewayId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.GatewaysApi.RetrieveGatewayStats(context.Background(), collectionId, gatewayId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GatewaysApi.RetrieveGatewayStats``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RetrieveGatewayStats`: GatewayStats
    fmt.Fprintf(os.Stdout, "Response from `GatewaysApi.RetrieveGatewayStats`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string
gatewayId	string

Other Parameters

Other parameters are passed through a pointer to a apiRetrieveGatewayStatsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

GatewayStats

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateGateway

Gateway UpdateGateway(ctx, existingCollectionId, gatewayId).Body(body).Execute()

Update gateway

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    existingCollectionId := "existingCollectionId_example" // string | 
    gatewayId := "gatewayId_example" // string | 
    body := *openapiclient.NewUpdateGatewayBody() // UpdateGatewayBody | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.GatewaysApi.UpdateGateway(context.Background(), existingCollectionId, gatewayId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GatewaysApi.UpdateGateway``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateGateway`: Gateway
    fmt.Fprintf(os.Stdout, "Response from `GatewaysApi.UpdateGateway`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
existingCollectionId	string
gatewayId	string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateGatewayRequest struct via the builder pattern

Name	Type	Description	Notes

body | UpdateGatewayBody | |

Return type

Gateway

Authorization

APIToken

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

GatewaysApi.md

Latest commit

History

GatewaysApi.md

File metadata and controls

\GatewaysApi

CreateGateway

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteGateway

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GatewayCertificates

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListGateways

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RetrieveGateway

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RetrieveGatewayStats

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateGateway

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers