Files
sdk/docs/NetworkAPI.md

17 KiB

\NetworkAPI

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
DeleteNetworkIdentitiesById Delete /v1/network/identities/{id} Takes one of the org's fabric identities out of the org.
DeleteNetworkServicesById Delete /v1/network/services/{id} Takes a name off the org's overlay: the two policies, the service and its two configs that publishing made, in that order, and the &quot;<name>-host&quot; role from each of the org's identities — that role exists only for the bind policy to select, and a role naming no service is one the identities endpoint refuses to write.
GetNetwork Get /v1/network Returns the caller's org overlay network on the Zero Trust fabric.
GetNetworkById Get /v1/network/{id} Returns one overlay network by id, scoped to the caller's org.
GetNetworkIdentities Get /v1/network/identities Returns the fabric identities the caller's org owns.
GetNetworkRouters Get /v1/network/routers Returns the Zero Trust routers the caller's org owns.
GetNetworkServices Get /v1/network/services Returns the Zero Trust edge services the caller's org owns.
PostNetworkIdentities Post /v1/network/identities Puts the caller on the org's overlay as its own IAM subject.
PostNetworkServices Post /v1/network/services Puts a name on the org's overlay: a fabric service forwarding to host:port on whichever of the org's devices carries the &quot;<name>-host&quot; role, dialable at &quot;<name>.<org>.zt&quot; by any of the org's identities — and by the cloud's own, which is what lets a BYO cluster's apiserver be attached to the fleet with a &quot;.zt&quot; kubeconfig.

DeleteNetworkIdentitiesById

DeleteNetworkIdentitiesById(ctx, id).Execute()

Takes one of the org's fabric identities out of the org.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | ID is the identity id from the path. The URL is the addressing authority, so it binds from there whatever else the request carries.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.NetworkAPI.DeleteNetworkIdentitiesById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `NetworkAPI.DeleteNetworkIdentitiesById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the identity id from the path. The URL is the addressing authority, so it binds from there whatever else the request carries.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/problem+json

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

DeleteNetworkServicesById

DeleteNetworkServicesById(ctx, id).Execute()

Takes a name off the org's overlay: the two policies, the service and its two configs that publishing made, in that order, and the "-host" role from each of the org's identities — that role exists only for the bind policy to select, and a role naming no service is one the identities endpoint refuses to write.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | ID is the service id from the path. The URL is the addressing authority, so it binds from there whatever else the request carries.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.NetworkAPI.DeleteNetworkServicesById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `NetworkAPI.DeleteNetworkServicesById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the service id from the path. The URL is the addressing authority, so it binds from there whatever else the request carries.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/problem+json

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

GetNetwork

NetworkNetworkList GetNetwork(ctx).Execute()

Returns the caller's org overlay network on the Zero Trust fabric.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

NetworkNetworkList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

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

GetNetworkById

NetworkNetworkView GetNetworkById(ctx, id).Execute()

Returns one overlay network by id, scoped to the caller's org.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | ID is the network id from the path. The URL is the addressing authority, so it binds from there whatever else the request carries.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the network id from the path. The URL is the addressing authority, so it binds from there whatever else the request carries.

Other Parameters

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

Name Type Description Notes

Return type

NetworkNetworkView

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

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

GetNetworkIdentities

NetworkIdentityList GetNetworkIdentities(ctx).Execute()

Returns the fabric identities the caller's org owns.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

NetworkIdentityList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

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

GetNetworkRouters

NetworkRouterList GetNetworkRouters(ctx).Execute()

Returns the Zero Trust routers the caller's org owns.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

NetworkRouterList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

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

GetNetworkServices

NetworkMeshServiceList GetNetworkServices(ctx).Execute()

Returns the Zero Trust edge services the caller's org owns.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

NetworkMeshServiceList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

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

PostNetworkIdentities

NetworkIdentityView PostNetworkIdentities(ctx).NetworkIdentityIn(networkIdentityIn).Execute()

Puts the caller on the org's overlay as its own IAM subject.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	networkIdentityIn := *openapiclient.NewNetworkIdentityIn() // NetworkIdentityIn | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
networkIdentityIn NetworkIdentityIn

Return type

NetworkIdentityView

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

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

PostNetworkServices

NetworkPublishedView PostNetworkServices(ctx).NetworkServiceIn(networkServiceIn).Execute()

Puts a name on the org's overlay: a fabric service forwarding to host:port on whichever of the org's devices carries the "-host" role, dialable at "..zt" by any of the org's identities — and by the cloud's own, which is what lets a BYO cluster's apiserver be attached to the fleet with a ".zt" kubeconfig.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	networkServiceIn := *openapiclient.NewNetworkServiceIn() // NetworkServiceIn | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
networkServiceIn NetworkServiceIn

Return type

NetworkPublishedView

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

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