Files
sdk/docs/DeployAPI.md

31 KiB

\DeployAPI

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

Method HTTP request Description
GetDeployApplications Get /v1/deploy/applications Returns the fleet as an argocd ApplicationList: one projected Application per operator App CR, carrying the image tag the CR DECLARES, the tag actually RUNNING in the cluster's Deployment, the reconciled health, and the sync verdict those two produce (declared == running ⇒ Synced, both known and different ⇒ OutOfSync, either unknown ⇒ Unknown).
GetDeployApplicationsByName Get /v1/deploy/applications/{name} Returns ONE projected argocd Application by name, with status.resources filled in from its reconciled resource tree — which is what makes it the detail view rather than a row of the list.
GetDeployApplicationsByNameResourceTree Get /v1/deploy/applications/{name}/resource-tree Returns one application's argocd ApplicationTree: the objects the operator reconciled from its App CR, reached by ownerRef — the Deployment and, under it, the ReplicaSet and Pods, plus the Service, Ingress, HorizontalPodAutoscaler, PodDisruptionBudget and ConfigMaps it owns — each node carrying its parent edges and its health.
GetDeployApplicationsByNameRevisionsByRevisionMetadata Get /v1/deploy/applications/{name}/revisions/{revision}/metadata Returns the argocd RevisionMetadata for one revision of one application — what the detail view shows beside a revision.
GetDeployApplicationsByNameSyncwindows Get /v1/deploy/applications/{name}/syncwindows Returns one application's argocd ApplicationSyncWindowState — the answer to "is anything blocking a sync of this application right now?".
GetDeployClusters Get /v1/deploy/clusters Returns the argocd ClusterList of the destinations the caller's applications reconcile into: one entry per distinct destination server, carrying the count of applications reconciling into it.
GetDeployHealth Get /v1/deploy/health Reports whether this deployment can observe the delivery plane.
GetDeployLive Get /v1/deploy/live Lists which image and which commit each service is running: for every Hanzo CD Application the caller may see, the images its live pods run (tag, digest, and the commit each was built from where the registry answers it), the universe commit CD last applied, CD's sync and health verdicts, and when it last synced.
GetDeployLogin Get /v1/deploy/login Start the sign-in round trip for this console
GetDeployProjects Get /v1/deploy/projects Returns the argocd AppProjectList this console groups and filters applications by.
GetDeploySessionUserinfo Get /v1/deploy/session/userinfo Answers "is this browser signed in, and if not where does it sign in?" — the dashboard SPA's bootstrap question, and the only route on this plane that answers for an anonymous caller.
GetDeployStreamApplications Get /v1/deploy/stream/applications Live application fleet updates as Server-Sent Events
GetDeployStreamApplicationsByNameResourceTree Get /v1/deploy/stream/applications/{name}/resource-tree Live resource tree for one application, as Server-Sent Events
PostDeployApplicationsByNameRollback Post /v1/deploy/applications/{name}/rollback Serves the console's rollback control, and today it requests a reconcile and nothing more.
PostDeployLogout Post /v1/deploy/logout Ends the console session on this host.

GetDeployApplications

DeployArgoAppList GetDeployApplications(ctx).Execute()

Returns the fleet as an argocd ApplicationList: one projected Application per operator App CR, carrying the image tag the CR DECLARES, the tag actually RUNNING in the cluster's Deployment, the reconciled health, and the sync verdict those two produce (declared == running ⇒ Synced, both known and different ⇒ OutOfSync, either unknown ⇒ Unknown).

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.DeployAPI.GetDeployApplications(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DeployAPI.GetDeployApplications``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDeployApplications`: DeployArgoAppList
	fmt.Fprintf(os.Stdout, "Response from `DeployAPI.GetDeployApplications`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

DeployArgoAppList

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]

GetDeployApplicationsByName

DeployArgoApp GetDeployApplicationsByName(ctx, name).Execute()

Returns ONE projected argocd Application by name, with status.resources filled in from its reconciled resource tree — which is what makes it the detail view rather than a row of the list.

Example

package main

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

func main() {
	name := "name_example" // string | Name is the application to read, from the path. It must be a DNS-1123 label (lowercase alphanumerics and hyphens, starting and ending alphanumeric) — every operator App CR's metadata.name satisfies that, and anything else is a 400 rather than a lookup.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name is the application to read, from the path. It must be a DNS-1123 label (lowercase alphanumerics and hyphens, starting and ending alphanumeric) — every operator App CR's metadata.name satisfies that, and anything else is a 400 rather than a lookup.

Other Parameters

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

Name Type Description Notes

Return type

DeployArgoApp

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]

GetDeployApplicationsByNameResourceTree

DeployArgoTree GetDeployApplicationsByNameResourceTree(ctx, name).Execute()

Returns one application's argocd ApplicationTree: the objects the operator reconciled from its App CR, reached by ownerRef — the Deployment and, under it, the ReplicaSet and Pods, plus the Service, Ingress, HorizontalPodAutoscaler, PodDisruptionBudget and ConfigMaps it owns — each node carrying its parent edges and its health.

Example

package main

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

func main() {
	name := "name_example" // string | Name is the application to read, from the path. It must be a DNS-1123 label (lowercase alphanumerics and hyphens, starting and ending alphanumeric) — every operator App CR's metadata.name satisfies that, and anything else is a 400 rather than a lookup.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name is the application to read, from the path. It must be a DNS-1123 label (lowercase alphanumerics and hyphens, starting and ending alphanumeric) — every operator App CR's metadata.name satisfies that, and anything else is a 400 rather than a lookup.

Other Parameters

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

Name Type Description Notes

Return type

DeployArgoTree

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]

GetDeployApplicationsByNameRevisionsByRevisionMetadata

DeployArgoRevisionMetadata GetDeployApplicationsByNameRevisionsByRevisionMetadata(ctx, name, revision).Execute()

Returns the argocd RevisionMetadata for one revision of one application — what the detail view shows beside a revision.

Example

package main

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

func main() {
	name := "name_example" // string | Name is the application to read, from the path. It must be a DNS-1123 label.
	revision := "revision_example" // string | Revision is the revision to describe, from the path. The empty revision and \"HEAD\" both mean \"whatever this application currently declares\".

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name is the application to read, from the path. It must be a DNS-1123 label.
revision string Revision is the revision to describe, from the path. The empty revision and "HEAD" both mean "whatever this application currently declares".

Other Parameters

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

Name Type Description Notes

Return type

DeployArgoRevisionMetadata

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]

GetDeployApplicationsByNameSyncwindows

DeployArgoSyncWindows GetDeployApplicationsByNameSyncwindows(ctx, name).Execute()

Returns one application's argocd ApplicationSyncWindowState — the answer to "is anything blocking a sync of this application right now?".

Example

package main

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

func main() {
	name := "name_example" // string | Name is the application to read, from the path. It must be a DNS-1123 label (lowercase alphanumerics and hyphens, starting and ending alphanumeric) — every operator App CR's metadata.name satisfies that, and anything else is a 400 rather than a lookup.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name is the application to read, from the path. It must be a DNS-1123 label (lowercase alphanumerics and hyphens, starting and ending alphanumeric) — every operator App CR's metadata.name satisfies that, and anything else is a 400 rather than a lookup.

Other Parameters

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

Name Type Description Notes

Return type

DeployArgoSyncWindows

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]

GetDeployClusters

DeployArgoClusterList GetDeployClusters(ctx).Execute()

Returns the argocd ClusterList of the destinations the caller's applications reconcile into: one entry per distinct destination server, carrying the count of applications reconciling into it.

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.DeployAPI.GetDeployClusters(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DeployAPI.GetDeployClusters``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDeployClusters`: DeployArgoClusterList
	fmt.Fprintf(os.Stdout, "Response from `DeployAPI.GetDeployClusters`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

DeployArgoClusterList

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]

GetDeployHealth

DeployDeployHealth GetDeployHealth(ctx).Execute()

Reports whether this deployment can observe the delivery plane.

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.DeployAPI.GetDeployHealth(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DeployAPI.GetDeployHealth``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDeployHealth`: DeployDeployHealth
	fmt.Fprintf(os.Stdout, "Response from `DeployAPI.GetDeployHealth`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

DeployDeployHealth

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]

GetDeployLive

DeployLive GetDeployLive(ctx).Execute()

Lists which image and which commit each service is running: for every Hanzo CD Application the caller may see, the images its live pods run (tag, digest, and the commit each was built from where the registry answers it), the universe commit CD last applied, CD's sync and health verdicts, and when it last synced.

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.DeployAPI.GetDeployLive(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DeployAPI.GetDeployLive``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDeployLive`: DeployLive
	fmt.Fprintf(os.Stdout, "Response from `DeployAPI.GetDeployLive`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

DeployLive

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]

GetDeployLogin

GetDeployLogin(ctx).Execute()

Start the sign-in round trip for this console

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetDeployProjects

DeployArgoProjectList GetDeployProjects(ctx).Execute()

Returns the argocd AppProjectList this console groups and filters applications by.

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.DeployAPI.GetDeployProjects(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DeployAPI.GetDeployProjects``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDeployProjects`: DeployArgoProjectList
	fmt.Fprintf(os.Stdout, "Response from `DeployAPI.GetDeployProjects`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

DeployArgoProjectList

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]

GetDeploySessionUserinfo

DeploySessionUser GetDeploySessionUserinfo(ctx).Execute()

Answers "is this browser signed in, and if not where does it sign in?" — the dashboard SPA's bootstrap question, and the only route on this plane that answers for an anonymous caller.

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.DeployAPI.GetDeploySessionUserinfo(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DeployAPI.GetDeploySessionUserinfo``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDeploySessionUserinfo`: DeploySessionUser
	fmt.Fprintf(os.Stdout, "Response from `DeployAPI.GetDeploySessionUserinfo`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

DeploySessionUser

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]

GetDeployStreamApplications

GetDeployStreamApplications(ctx).Execute()

Live application fleet updates as Server-Sent Events

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetDeployStreamApplicationsByNameResourceTree

GetDeployStreamApplicationsByNameResourceTree(ctx, name).Execute()

Live resource tree for one application, as Server-Sent Events

Example

package main

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

func main() {
	name := "name_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.DeployAPI.GetDeployStreamApplicationsByNameResourceTree(context.Background(), name).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DeployAPI.GetDeployStreamApplicationsByNameResourceTree``: %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.
name string

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

PostDeployApplicationsByNameRollback

DeployArgoApp PostDeployApplicationsByNameRollback(ctx, name).Execute()

Serves the console's rollback control, and today it requests a reconcile and nothing more.

Example

package main

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

func main() {
	name := "name_example" // string | Name is the application to read, from the path. It must be a DNS-1123 label (lowercase alphanumerics and hyphens, starting and ending alphanumeric) — every operator App CR's metadata.name satisfies that, and anything else is a 400 rather than a lookup.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name is the application to read, from the path. It must be a DNS-1123 label (lowercase alphanumerics and hyphens, starting and ending alphanumeric) — every operator App CR's metadata.name satisfies that, and anything else is a 400 rather than a lookup.

Other Parameters

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

Name Type Description Notes

Return type

DeployArgoApp

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]

PostDeployLogout

DeploySessionEnded PostDeployLogout(ctx).Execute()

Ends the console session on this host.

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.DeployAPI.PostDeployLogout(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DeployAPI.PostDeployLogout``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostDeployLogout`: DeploySessionEnded
	fmt.Fprintf(os.Stdout, "Response from `DeployAPI.PostDeployLogout`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

DeploySessionEnded

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]