Categorygithub.com/tsuru/go-tsuruclient
module
0.0.0-20250123194536-680fecb3501a
Repository: https://github.com/tsuru/go-tsuruclient.git
Documentation: pkg.go.dev

# README

Go API client for tsuru

Open source, extensible and Docker-based Platform as a Service (PaaS)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.24
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./tsuru"

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
AppApiAppBuildPost /1.5/apps/{app}/build
AppApiAppCnameAddPost /1.0/apps/{app}/cname
AppApiAppCnameDeleteDelete /1.0/apps/{app}/cname
AppApiAppCreatePost /1.0/apps
AppApiAppDeleteDelete /1.0/apps/{app}
AppApiAppDeployPost /1.0/apps/{app}/deploy
AppApiAppGetGet /1.0/apps/{app}
AppApiAppGetCertificatesGet /1.24/apps/{app}/certificate
AppApiAppListGet /1.0/apps
AppApiAppQuotaChangePut /1.0/apps/{app}/quota
AppApiAppQuotaGetGet /1.0/apps/{app}/quota
AppApiAppRestartPost /1.0/apps/{app}/restart
AppApiAppRouterAddPost /1.5/apps/{app}/routers
AppApiAppRouterDeleteDelete /1.5/apps/{app}/routers/{router}
AppApiAppRouterListGet /1.5/apps/{app}/routers
AppApiAppRouterUpdatePut /1.5/apps/{app}/routers/{router}
AppApiAppRunPost /1.0/apps/{app}/run
AppApiAppSetCertIssuerPut /1.24/apps/{app}/certissuer
AppApiAppSetRoutablePost /1.8/apps/{app}/routable
AppApiAppStartPost /1.0/apps/{app}/start
AppApiAppStopPost /1.0/apps/{app}/stop
AppApiAppTeamGrantPut /1.0/apps/{app}/teams/{team}
AppApiAppTeamRevokeDelete /1.0/apps/{app}/teams/{team}
AppApiAppUnsetCertIssuerDelete /1.24/apps/{app}/certissuer
AppApiAppUpdatePut /1.0/apps/{app}
AppApiAutoScaleAddPost /1.9/apps/{app}/units/autoscale
AppApiAutoScaleInfoGet /1.9/apps/{app}/units/autoscale
AppApiAutoScaleRemoveDelete /1.9/apps/{app}/units/autoscale
AppApiCertificatUnsetDelete /1.0/apps/{app}/certificate
AppApiCertificateSetPut /1.0/apps/{app}/certificate
AppApiEnvGetGet /1.0/apps/{app}/env
AppApiEnvSetPost /1.0/apps/{app}/env
AppApiEnvUnsetDelete /1.0/apps/{app}/env
AppApiUnitsAddPut /1.0/apps/{app}/units
AppApiUnitsRemoveDelete /1.0/apps/{app}/units
AuthApiAssignRoleToGroupPost /1.9/roles/{role_name}/group
AuthApiAssignRoleToTokenPost /1.6/roles/{role_name}/token
AuthApiCreateRolePost /1.0/roles
AuthApiDefaultRoleAddPost /1.0/role/default
AuthApiDeleteRoleDelete /1.0/roles/{role_name}
AuthApiDissociateRoleDelete /1.0/roles/{role_name}/user/{email}
AuthApiDissociateRoleFromGroupDelete /1.6/roles/{role_name}/group/{group_name}
AuthApiDissociateRoleFromTokenDelete /1.6/roles/{role_name}/token/{token_id}
AuthApiPermissionAddPost /1.0/roles/{role_name}/permissions
AuthApiRemovePermissionDelete /1.0/roles{role_name}/permissions/{permission}
AuthApiRoleAssignPost /1,0/roles/{role_name}/user
AuthApiRoleDefaultDeleteDelete /1.0/role/default
AuthApiTeamTokenCreatePost /1.6/tokens
AuthApiTeamTokenDeleteDelete /1.6/tokens/{token_id}
AuthApiTeamTokenInfoGet /1.7/tokens/{token_id}
AuthApiTeamTokenUpdatePut /1.6/tokens/{token_id}
AuthApiTeamTokensListGet /1.6/tokens
AuthApiUpdateRolePut /1.0/roles
ClusterApiClusterCreatePost /1.3/provisioner/clusters
ClusterApiClusterDeleteDelete /1.3/provisioner/clusters/{cluster_name}
ClusterApiClusterInfoGet /1.8/provisioner/clusters/{cluster_name}
ClusterApiClusterListGet /1.3/provisioner/clusters
ClusterApiClusterUpdatePost /1.4/provisioner/clusters/{cluster_name}
ClusterApiProvisionerListGet /1.7/provisioner
EventApiEventCancelPost /1.1/events/{eventid}/cancel
EventApiEventInfoGet /1.1/events/{eventid}
EventApiWebhookCreatePost /1.6/events/webhooks
EventApiWebhookDeleteDelete /1.6/events/webhooks/{name}
EventApiWebhookGetGet /1.6/events/webhooks/{name}
EventApiWebhookListGet /1.6/events/webhooks
EventApiWebhookUpdatePut /1.6/events/webhooks/{name}
JobApiCreateJobPost /1.13/jobs
JobApiDeleteJobDelete /1.13/jobs/{name}
JobApiGetJobGet /1.13/jobs/{name}
JobApiJobEnvGetGet /1.16/jobs/{name}/env
JobApiJobEnvSetPost /1.13/jobs/{name}/env
JobApiJobEnvUnsetDelete /1.13/jobs/{name}/env
JobApiJobLogGet /1.13/jobs/{name}/log
JobApiListJobGet /1.13/jobs
JobApiTriggerJobPost /1.13/jobs/{name}/trigger
JobApiUpdateJobPut /1.13/jobs/{name}
PlanApiDeletePlanDelete /1.0/plans/{plan}
PlanApiPlanCreatePost /1.0/plans
PlanApiPlanListGet /1.0/plans
PlatformApiPlatformAddPost /1.0/platforms
PlatformApiPlatformDeleteDelete /1.0/platforms/{platform}
PlatformApiPlatformInfoGet /1.6/platforms/{platform}
PlatformApiPlatformListGet /1.0/platforms
PlatformApiPlatformRollbackPost /1.6/platforms/{platform}/rollback
PlatformApiPlatformUpdatePut /1.0/platforms/{platform}
PoolApiConstraintListGet /1.3/constraints
PoolApiConstraintSetPut /1.3/constraints
PoolApiPoolCreatePost /1.0/pools
PoolApiPoolDeleteDelete /pools/{pool}
PoolApiPoolGetGet /pools/{pool}
PoolApiPoolListGet /1.0/pools
PoolApiPoolUpdatePut /pools/{pool}
RouterApiRouterCreatePost /1.8/routers
RouterApiRouterDeleteDelete /1.8/routers/{name}
RouterApiRouterListGet /1.3/routers
RouterApiRouterUpdatePut /1.8/routers/{name}
ServiceApiInstanceCreatePost /1.0/services/{service}/instances
ServiceApiInstanceDeleteDelete /1.0/services/{service}/instances/{instance}
ServiceApiInstanceGetGet /1.0/services/{service}/instances/{instance}
ServiceApiInstanceUpdatePut /1.0/services/{service}/instances/{instance}
ServiceApiInstancesListGet /1.0/services/instances
ServiceApiJobServiceInstanceBindPut /1.13/services/{service}/instances/{instance}/jobs/{job}
ServiceApiJobServiceInstanceUnbindDelete /1.13/services/{service}/instances/{instance}/jobs/{job}
ServiceApiServiceAddDocPut /1.0/services/{name}/doc
ServiceApiServiceBrokerCreatePost /1.7/brokers
ServiceApiServiceBrokerDeleteDelete /1.7/brokers/{name}
ServiceApiServiceBrokerListGet /1.7/brokers
ServiceApiServiceBrokerUpdatePut /1.7/brokers/{name}
ServiceApiServiceCreatePost /1.0/services
ServiceApiServiceDeleteDelete /1.0/services/{name}
ServiceApiServiceDocGet /1.0/services/{name}/doc
ServiceApiServiceGrantTeamPut /1.0/services/{service}/team/{team}
ServiceApiServiceInfoGet /1.0/services/{name}
ServiceApiServiceInstanceBindPut /1.13/services/{service}/instances/{instance}/apps/{app}
ServiceApiServiceInstanceBind10Put /1.0/services/{service}/instances/{instance}/{app}
ServiceApiServiceInstanceGrantPut /1.0/services/{service}/instances/permission/{instance}/{team}
ServiceApiServiceInstanceRevokeDelete /1.0/services/{service}/instances/permission/{instance}/{team}
ServiceApiServiceInstanceStatusGet /1.0/services/{service}/instances/{instance}/status
ServiceApiServiceInstanceUnbindDelete /1.13/services/{service}/instances/{instance}/apps/{app}
ServiceApiServiceInstanceUnbind10Delete /1.0/services/{service}/instances/{instance}/{app}
ServiceApiServicePlansGet /1.0/services/{name}/plans
ServiceApiServiceRevokeTeamDelete /1.0/services/{service}/team/{team}
ServiceApiServiceUpdatePut /1.0/services/{name}
ServiceApiServicesListGet /1.0/services
TeamApiTeamCreatePost /1.0/teams
TeamApiTeamDeleteDelete /1.0/teams/{team}
TeamApiTeamGetGet /1.4/teams/{team}
TeamApiTeamGroupListGet /1.17/teams/{team}/groups
TeamApiTeamQuotaChangePut /1.12/teams/{team}/quota
TeamApiTeamQuotaGetGet /1.12/teams/{team}/quota
TeamApiTeamUpdatePut /1.6/teams/{team}
TeamApiTeamUserListGet /1.17/teams/{team}/users
TeamApiTeamsListGet /1.0/teams
UserApiAPITokenGetGet /1.0/users/api-key
UserApiAPITokenRegeneratePost /1.0/users/api-key
UserApiChangePasswordPut /1.0/users/password
UserApiResetPasswordPost /1.0/users/{email}/password
UserApiUserCreatePost /1.0/users
UserApiUserDeleteDelete /1.0/users
UserApiUserGetGet /1.0/users/info
UserApiUserQuotaChangePut /1.0/users/{email}/quota
UserApiUserQuotaGetGet /1.0/users/{email}/quota
UserApiUserTokenDeleteDelete /1.0/users/tokens
UserApiUsersListGet /1.0/users
VolumeApiVolumeBindPost /1.4/volumes/{volume}/bind
VolumeApiVolumeCreatePost /1.4/volumes
VolumeApiVolumeDeleteDelete /1.4/volumes/{volume}
VolumeApiVolumeGetGet /1.4/volumes/{volume}
VolumeApiVolumeListGet /1.4/volumes
VolumeApiVolumePlansListGet /1.4/volumeplans
VolumeApiVolumeUnbindDelete /1.4/volumes/{volume}/bind
VolumeApiVolumeUpdatePut /1.4/volumes/{volume}

Documentation For Models

Documentation For Authorization

Bearer

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

# Packages

No description provided by the author