Skip to content

Latest commit

 

History

History
518 lines (474 loc) · 33.5 KB

README.md

File metadata and controls

518 lines (474 loc) · 33.5 KB
Raw

Go API client for koyeb

The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests.

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.0.0
  • 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

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

import koyeb "github.com/koyeb/koyeb-api-client-go/koyeb"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), koyeb.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), koyeb.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), koyeb.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), koyeb.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://app.koyeb.com

Class Method HTTP request Description
ActivityApi GetAccountActivities Get /v1/account/activities
ActivityApi ListActivities Get /v1/activities
ActivityApi ListNotifications Get /v1/notifications
AppsApi CreateApp Post /v1/apps Create App
AppsApi DeleteApp Delete /v1/apps/{id} Delete App
AppsApi GetApp Get /v1/apps/{id} Get App
AppsApi ListAppEvents Get /v1/app_events List App events
AppsApi ListApps Get /v1/apps List App
AppsApi PauseApp Post /v1/apps/{id}/pause Pause App
AppsApi ResumeApp Post /v1/apps/{id}/resume Resume App
AppsApi UpdateApp Put /v1/apps/{id} Update App
AppsApi UpdateApp2 Patch /v1/apps/{id} Update App
BillingApi HasUnpaidInvoices Get /v1/billing/has_unpaid_invoices Experimental: Has unpaid invoices
BillingApi Manage Get /v1/billing/manage
BillingApi NextInvoice Get /v1/billing/next_invoice Experimental: Fetch next invoice
CatalogDatacentersApi ListDatacenters Get /v1/catalog/datacenters List datacenters
CatalogInstancesApi GetCatalogInstance Get /v1/catalog/instances/{id} Get Instance
CatalogInstancesApi ListCatalogInstances Get /v1/catalog/instances List Instance
CatalogRegionsApi GetRegion Get /v1/catalog/regions/{id} Get Region
CatalogRegionsApi ListRegions Get /v1/catalog/regions List Region
CredentialsApi CreateCredential Post /v1/credentials Create credential
CredentialsApi DeleteCredential Delete /v1/credentials/{id} Delete credential
CredentialsApi GetCredential Get /v1/credentials/{id} Get credential
CredentialsApi ListCredentials Get /v1/credentials List credentials
CredentialsApi UpdateCredential Put /v1/credentials/{id} Update credential
CredentialsApi UpdateCredential2 Patch /v1/credentials/{id} Update credential
DeploymentsApi CancelDeployment Post /v1/deployments/{id}/cancel Cancel Deployment
DeploymentsApi GetDeployment Get /v1/deployments/{id} Get Deployment
DeploymentsApi ListDeploymentEvents Get /v1/deployment_events List Deployment events
DeploymentsApi ListDeployments Get /v1/deployments List Deployments
DockerHelperApi VerifyDockerImage Get /v1/docker-helper/verify Verify if a docker image is reachable
DomainsApi CreateDomain Post /v1/domains
DomainsApi DeleteDomain Delete /v1/domains/{id}
DomainsApi GetDomain Get /v1/domains/{id}
DomainsApi ListDomains Get /v1/domains
DomainsApi RefreshDomainStatus Post /v1/domains/{id}/refresh
DomainsApi UpdateDomain Patch /v1/domains/{id}
InstancesApi ExecCommand Get /v1/streams/instances/exec Exec Command
InstancesApi GetInstance Get /v1/instances/{id} Get Instance
InstancesApi ListInstanceEvents Get /v1/instance_events List Instance events
InstancesApi ListInstances Get /v1/instances List Instances
InviteApi CreateInvite Post /v1/account/invite
LogsApi TailLogs Get /v1/streams/logs/tail Tails logs
MetricsApi GetMetrics Get /v1/streams/metrics
OrganizationApi CreateOrganization Post /v1/organizations Create organization
OrganizationApi DeactivateOrganization Post /v1/organizations/{id}/deactivate Deactivate an organization
OrganizationApi DeleteOrganization Delete /v1/organizations/{id} Delete an organization
OrganizationApi GetGithubInstallation Get /v1/github/installation Fetch github installation configuration
OrganizationApi GetOrganization Get /v1/organizations/{id} Get organization
OrganizationApi GithubInstallation Post /v1/github/installation Start github installation
OrganizationApi GithubInstallationCallback Post /v1/github/installation/callback Github callback for app installation
OrganizationApi ReactivateOrganization Post /v1/organizations/{id}/reactivate Reactivate an organization
OrganizationApi SwitchOrganization Post /v1/organizations/{id}/switch Switch organization context
OrganizationApi UpdateOrganization Put /v1/organizations/{id} Update organization
OrganizationApi UpdateOrganization2 Patch /v1/organizations/{id} Update organization
OrganizationApi UpdateOrganizationPlan Post /v1/organizations/{id}/plan Update organization plan
OrganizationApi UpsertSignupQualification Post /v1/organizations/{id}/signup_qualification Upsert organization's signup qualification
OrganizationConfirmationsApi ConfirmOrganizationAction Post /v1/organization_confirmations/{id} Confirm organization action
OrganizationInvitationsApi CreateOrganizationInvitation Post /v1/organization_invitations
OrganizationInvitationsApi DeleteOrganizationInvitation Delete /v1/organization_invitations/{id}
OrganizationInvitationsApi GetOrganizationInvitation Get /v1/organization_invitations/{id}
OrganizationInvitationsApi ListOrganizationInvitations Get /v1/organization_invitations
OrganizationInvitationsApi ResendOrganizationInvitation Post /v1/organization_invitations/{id}/resend
OrganizationMembersApi ListOrganizationMembers Get /v1/organization_members List organization members
OrganizationMembersApi RemoveOrganizationMember Delete /v1/organization_members/{id} Remove an organization member
OrganizationQuotasApi GetQuotas Get /v1/organizations/{organization_id}/quotas
PaymentMethodsApi ConfirmPaymentAuthorization Post /v1/payment_methods/{id}/confirm Confirm payment authorization
PaymentMethodsApi CreatePaymentAuthorization Post /v1/payment_methods Create payment authorization
PaymentMethodsApi DeletePaymentMethod Delete /v1/payment_methods/{id} Delete payment method
PaymentMethodsApi GetPaymentMethod Get /v1/payment_methods/{id} Get payment method
PaymentMethodsApi ListPaymentMethods Get /v1/payment_methods List payment methods
ProfileApi AcceptOrganizationInvitation Post /v1/account/organization_invitations/{id}/accept
ProfileApi DeclineOrganizationInvitation Post /v1/account/organization_invitations/{id}/decline
ProfileApi GetCurrentOrganization Get /v1/account/organization
ProfileApi GetCurrentUser Get /v1/account/profile
ProfileApi GetOAuthOptions Get /v1/account/oauth Get OAuth Providers
ProfileApi GetUserOrganizationInvitation Get /v1/account/organization_invitations/{id}
ProfileApi ListUserOrganizationInvitations Get /v1/account/organization_invitations
ProfileApi OAuthCallback Post /v1/account/oauth Authenticate using OAuth
ProfileApi ResendEmailValidation Post /v1/account/resend_validation
ProfileApi ResetPassword Post /v1/account/reset_password
ProfileApi Signup Post /v1/account/signup
ProfileApi UpdatePassword Post /v1/account/update_password
ProfileApi UpdateUser Put /v1/account/profile
ProfileApi UpdateUser2 Patch /v1/account/profile
ProfileApi Validate Post /v1/account/validate/{id}
QuotasApi ReviewOrganizationCapacity Post /v1/quotas/capacity Review Organization Capacity
RegionalDeploymentsApi GetRegionalDeployment Get /v1/regional_deployments/{id} Experimental: Get regional deployment Use at your own risk
RegionalDeploymentsApi ListRegionalDeploymentEvents Get /v1/regional_deployment_events List Regional Deployment events
RegionalDeploymentsApi ListRegionalDeployments Get /v1/regional_deployments Experimental: List regional deployments Use at your own risk
RepositoriesApi ListBranches Get /v1/git/branches
RepositoriesApi ListRepositories Get /v1/git/repositories
RepositoriesApi ResyncOrganization Post /v1/git/sync/organization/{organization_id}
SearchApi Search Get /v1/search Search
SecretsApi CreateSecret Post /v1/secrets
SecretsApi DeleteSecret Delete /v1/secrets/{id}
SecretsApi GetSecret Get /v1/secrets/{id}
SecretsApi ListSecrets Get /v1/secrets
SecretsApi RevealSecret Post /v1/secrets/{id}/reveal
SecretsApi UpdateSecret Put /v1/secrets/{id}
SecretsApi UpdateSecret2 Patch /v1/secrets/{id}
ServicesApi CreateService Post /v1/services Create Service
ServicesApi DeleteService Delete /v1/services/{id} Delete Service
ServicesApi GetService Get /v1/services/{id} Get Service
ServicesApi ListServiceEvents Get /v1/service_events List Service events
ServicesApi ListServices Get /v1/services List Services
ServicesApi PauseService Post /v1/services/{id}/pause Pause Service
ServicesApi ReDeploy Post /v1/services/{id}/redeploy ReDeploy Service
ServicesApi ResumeService Post /v1/services/{id}/resume Resume Service
ServicesApi UpdateService Put /v1/services/{id} Update Service
ServicesApi UpdateService2 Patch /v1/services/{id} Update Service
SessionsApi Login Post /v1/account/login Login user
SessionsApi Logout Delete /v1/account/logout Logout user
SessionsApi NewSession Post /v1/account/session New session
SessionsApi RefreshToken Put /v1/account/refresh Refresh token
SsoApi CannyAuth Post /v1/sso/canny
SsoApi DiscourseAuth Post /v1/sso/discourse
SubscriptionsApi GetSubscription Get /v1/subscriptions/{id} Get Subscription
SummaryApi GetOrganizationSummary Get /v1/organizations/{organization_id}/summary Get organization usage summary
UsagesApi GetOrganizationUsage Get /v1/usages Get organization usage
UsagesApi GetOrganizationUsageDetails Get /v1/usages/details Get organization usage details
UsersApi DeleteUser Delete /v1/users/{id} Delete user

Documentation For Models

Documentation For Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author