SelfApi.md

\SelfApi

All URIs are relative to https://api.clever-cloud.com/v2

Method	HTTP request	Description
AddEmailAddress	Put /self/emails/{email}
AddSelfAddonTagByAddonId	Put /self/addons/{addonId}/tags/{tag}
AddSelfApplication	Post /self/applications
AddSelfApplicationDependencyByAppId	Put /self/applications/{appId}/dependencies/{dependencyId}
AddSelfApplicationTagByAppId	Put /self/applications/{appId}/tags/{tag}
AddSelfPaymentMethod	Post /self/payments/methods
AddSelfVhostByAppId	Put /self/applications/{appId}/vhosts/{domain}
AddSshKey	Put /self/keys/{key}
BuySelfDrops	Post /self/payments/billings
CancelDeploy	Delete /self/applications/{appId}/deployments/{deploymentId}/instances
ChangeSelfAddonPlanByAddonId	Put /self/addons/{addonId}/plan
ChangeUserPassword	Put /self/change_password
ChooseSelfPaymentProvider	Put /self/payments/billings/{bid}
CreateMFA	Post /self/mfa/{kind}
CreateSelfConsumer	Post /self/consumers
DeleteMFA	Delete /self/mfa/{kind}
DeleteSelfAddonTagByAddonId	Delete /self/addons/{addonId}/tags/{tag}
DeleteSelfApplicationByAppId	Delete /self/applications/{appId}
DeleteSelfApplicationDependencyByAppId	Delete /self/applications/{appId}/dependencies/{dependencyId}
DeleteSelfApplicationTagAppId	Delete /self/applications/{appId}/tags/{tag}
DeleteSelfCard	Delete /self/payments/methods/{mId}
DeleteSelfConsumer	Delete /self/consumers/{key}
DeleteSelfPurchaseOrder	Delete /self/payments/billings/{bid}
DeleteSelfRecurrentPayment	Delete /self/payments/recurring
DeleteUser	Delete /self
DeprovisionSelfAddonById	Delete /self/addons/{addonId}
EditSelfApplicationByAppId	Put /self/applications/{appId}
EditSelfApplicationEnvByAppId	Put /self/applications/{appId}/env
EditSelfApplicationEnvByAppIdAndEnvName	Put /self/applications/{appId}/env/{envName}
EditUser	Put /self
FavMFA	Put /self/mfa/{kind}
GetAddonSSOData	Get /self/addons/{addonId}/sso
GetApplicationDeployment	Get /self/applications/{appId}/deployments/{deploymentId}
GetApplicationDeployments	Get /self/applications/{appId}/deployments
GetBackupCodes	Get /self/mfa/{kind}/backupcodes
GetConfirmationEmail	Get /self/confirmation_email
GetConsumptions	Get /self/consumptions
GetEmailAddresses	Get /self/emails
GetId	Get /self/id
GetSelfAddonById	Get /self/addons/{addonId}
GetSelfAddonEnvByAddonId	Get /self/addons/{addonId}/env
GetSelfAddonTagsByAddonId	Get /self/addons/{addonId}/tags
GetSelfAddons	Get /self/addons
GetSelfAddonsLinkedToApplicationByAppId	Get /self/applications/{appId}/addons
GetSelfAmount	Get /self/credits
GetSelfApplicationBranchesByAppId	Get /self/applications/{appId}/branches
GetSelfApplicationByAppId	Get /self/applications/{appId}
GetSelfApplicationDependenciesByAppId	Get /self/applications/{appId}/dependencies
GetSelfApplicationDependenciesEnvByAppId	Get /self/applications/{appId}/dependencies/env
GetSelfApplicationDependents	Get /self/applications/{appId}/dependents
GetSelfApplicationEnvByAppId	Get /self/applications/{appId}/env
GetSelfApplicationInstanceByAppAndInstanceId	Get /self/applications/{appId}/instances/{instanceId}
GetSelfApplicationInstancesByAppId	Get /self/applications/{appId}/instances
GetSelfApplicationTagsByAppId	Get /self/applications/{appId}/tags
GetSelfApplications	Get /self/applications
GetSelfApplicationsLinkedToAddonByAddonId	Get /self/addons/{addonId}/applications
GetSelfCliTokens	Get /self/cli_tokens
GetSelfConsumer	Get /self/consumers/{key}
GetSelfConsumerSecret	Get /self/consumers/{key}/secret
GetSelfConsumers	Get /self/consumers
GetSelfDefaultMethod	Get /self/payments/methods/default
GetSelfEnvOfAddonsLinkedToApplicationByAppId	Get /self/applications/{appId}/addons/env
GetSelfExposedEnvByAppId	Get /self/applications/{appId}/exposed_env
GetSelfFavouriteVhostByAppId	Get /self/applications/{appId}/vhosts/favourite
GetSelfInstancesForAllApps	Get /self/instances
GetSelfInvoiceById	Get /self/payments/billings/{bid}
GetSelfInvoices	Get /self/payments/billings
GetSelfMonthlyInvoice	Get /self/payments/monthlyinvoice
GetSelfPaymentInfo	Get /self/payment-info
GetSelfPaymentMethods	Get /self/payments/methods
GetSelfPdfInvoiceById	Get /self/payments/billings/{bid}.pdf
GetSelfPriceWithTax	Get /self/payments/fullprice/{price}
GetSelfRecurrentPayment	Get /self/payments/recurring
GetSelfStripeToken	Get /self/payments/tokens/stripe
GetSelfTokens	Get /self/tokens
GetSelfVhostByAppId	Get /self/applications/{appId}/vhosts
GetSshKeys	Get /self/keys
GetSummary	Get /summary
GetUser	Get /self
LinkSelfAddonToApplicationByAppId	Post /self/applications/{appId}/addons
MarkSelfFavouriteVhostByAppId	Put /self/applications/{appId}/vhosts/favourite
PreorderSelfAddon	Post /self/addons/preorders
ProvisionSelfAddon	Post /self/addons
RedeploySelfApplicationByAppId	Post /self/applications/{appId}/instances
RemoveEmailAddress	Delete /self/emails/{email}
RemoveSelfApplicationEnvByAppIdAndEnvName	Delete /self/applications/{appId}/env/{envName}
RemoveSelfVhostByAppId	Delete /self/applications/{appId}/vhosts/{domain}
RemoveSshKey	Delete /self/keys/{key}
RenameAddon	Put /self/addons/{addonId}
RevokeAllTokens	Delete /self/tokens
RevokeToken	Delete /self/tokens/{token}
SetSelfApplicationBranchByAppId	Put /self/applications/{appId}/branch
SetSelfBuildInstanceFlavorByAppId	Put /self/applications/{appId}/buildflavor
SetSelfDefaultMethod	Put /self/payments/methods/default
SetSelfMaxCreditsPerMonth	Put /self/payments/monthlyinvoice/maxcredit
SetUserAvatarFromString	Put /self/avatar
UndeploySelfApplicationByAppId	Delete /self/applications/{appId}/instances
UnlinkSelfddonFromApplicationByAppAndAddonId	Delete /self/applications/{appId}/addons/{addonId}
UnmarkSelfFavouriteVhostByAppId	Delete /self/applications/{appId}/vhosts/favourite
UpdateSelfConsumer	Put /self/consumers/{key}
UpdateSelfExposedEnvByAppId	Put /self/applications/{appId}/exposed_env
ValidateEmail	Get /self/validate_email
ValidateMFA	Post /self/mfa/{kind}/confirmation

AddEmailAddress

Message AddEmailAddress(ctx, email, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
email	string
optional	*AddEmailAddressOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AddEmailAddressOpts struct

Name	Type	Description	Notes

body | optional.String| |

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

AddSelfAddonTagByAddonId

[]string AddSelfAddonTagByAddonId(ctx, addonId, tag)

Required Parameters

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

Return type

[]string

Authorization

No authorization required

HTTP request headers

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

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

AddSelfApplication

ApplicationView AddSelfApplication(ctx, wannabeApplication)

Required Parameters

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

Return type

ApplicationView

Authorization

No authorization required

HTTP request headers

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

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

AddSelfApplicationDependencyByAppId

Message AddSelfApplicationDependencyByAppId(ctx, appId, dependencyId)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

AddSelfApplicationTagByAppId

[]string AddSelfApplicationTagByAppId(ctx, appId, tag)

Required Parameters

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

Return type

[]string

Authorization

No authorization required

HTTP request headers

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

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

AddSelfPaymentMethod

PaymentMethodView AddSelfPaymentMethod(ctx, paymentData)

Required Parameters

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

Return type

PaymentMethodView

Authorization

No authorization required

HTTP request headers

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

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

AddSelfVhostByAppId

Message AddSelfVhostByAppId(ctx, appId, domain)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

AddSshKey

Message AddSshKey(ctx, key)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

BuySelfDrops

InvoiceRendering BuySelfDrops(ctx, wannaBuyPackage)

Required Parameters

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

Return type

InvoiceRendering

Authorization

No authorization required

HTTP request headers

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

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

CancelDeploy

Message CancelDeploy(ctx, appId, deploymentId)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

ChangeSelfAddonPlanByAddonId

AddonView ChangeSelfAddonPlanByAddonId(ctx, addonId, wannabePlanChange)

Required Parameters

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

Return type

AddonView

Authorization

No authorization required

HTTP request headers

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

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

ChangeUserPassword

Message ChangeUserPassword(ctx, wannabePassword)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

ChooseSelfPaymentProvider

NextInPaymentFlow ChooseSelfPaymentProvider(ctx, bid, paymentProviderSelection)

Required Parameters

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

Return type

NextInPaymentFlow

Authorization

No authorization required

HTTP request headers

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

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

CreateMFA

CreateMFA(ctx, kind)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

CreateSelfConsumer

OAuth1ConsumerView CreateSelfConsumer(ctx, wannabeOAuth1Consumer)

Required Parameters

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

Return type

OAuth1ConsumerView

Authorization

No authorization required

HTTP request headers

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

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

DeleteMFA

DeleteMFA(ctx, kind)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

DeleteSelfAddonTagByAddonId

[]string DeleteSelfAddonTagByAddonId(ctx, addonId, tag)

Required Parameters

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

Return type

[]string

Authorization

No authorization required

HTTP request headers

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

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

DeleteSelfApplicationByAppId

Message DeleteSelfApplicationByAppId(ctx, appId)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

DeleteSelfApplicationDependencyByAppId

DeleteSelfApplicationDependencyByAppId(ctx, appId, dependencyId)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

DeleteSelfApplicationTagAppId

[]string DeleteSelfApplicationTagAppId(ctx, appId, tag)

Required Parameters

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

Return type

[]string

Authorization

No authorization required

HTTP request headers

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

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

DeleteSelfCard

DeleteSelfCard(ctx, mId)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

DeleteSelfConsumer

DeleteSelfConsumer(ctx, key)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

DeleteSelfPurchaseOrder

DeleteSelfPurchaseOrder(ctx, bid)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

DeleteSelfRecurrentPayment

DeleteSelfRecurrentPayment(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

DeleteUser

Message DeleteUser(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

DeprovisionSelfAddonById

Message DeprovisionSelfAddonById(ctx, addonId)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

EditSelfApplicationByAppId

ApplicationView EditSelfApplicationByAppId(ctx, appId, wannabeApplication)

Required Parameters

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

Return type

ApplicationView

Authorization

No authorization required

HTTP request headers

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

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

EditSelfApplicationEnvByAppId

ApplicationView EditSelfApplicationEnvByAppId(ctx, appId, body)

Required Parameters

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

Return type

ApplicationView

Authorization

No authorization required

HTTP request headers

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

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

EditSelfApplicationEnvByAppIdAndEnvName

ApplicationView EditSelfApplicationEnvByAppIdAndEnvName(ctx, appId, envName, wannabeValue)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appId	string
envName	string
wannabeValue	WannabeValue

Return type

ApplicationView

Authorization

No authorization required

HTTP request headers

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

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

EditUser

UserView EditUser(ctx, wannabeUser)

Required Parameters

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

Return type

UserView

Authorization

No authorization required

HTTP request headers

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

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

FavMFA

FavMFA(ctx, kind, wannabeMfaFav)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

GetAddonSSOData

AddonSsoData GetAddonSSOData(ctx, addonId)

Required Parameters

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

Return type

AddonSsoData

Authorization

No authorization required

HTTP request headers

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

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

GetApplicationDeployment

GetApplicationDeployment(ctx, appId, deploymentId)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

GetApplicationDeployments

[]DeploymentView GetApplicationDeployments(ctx, appId, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appId	string
optional	*GetApplicationDeploymentsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetApplicationDeploymentsOpts struct

Name	Type	Description	Notes

limit | optional.String| | offset | optional.String| | action | optional.String| |

Return type

[]DeploymentView

Authorization

No authorization required

HTTP request headers

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

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

GetBackupCodes

[]MfaRecoveryCode GetBackupCodes(ctx, kind)

Required Parameters

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

Return type

[]MfaRecoveryCode

Authorization

No authorization required

HTTP request headers

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

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

GetConfirmationEmail

Message GetConfirmationEmail(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

GetConsumptions

string GetConsumptions(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetConsumptionsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetConsumptionsOpts struct

Name	Type	Description	Notes
appId	optional.String
from	optional.String
to	optional.String
for_	optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

GetEmailAddresses

[]string GetEmailAddresses(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]string

Authorization

No authorization required

HTTP request headers

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

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

GetId

string GetId(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

GetSelfAddonById

AddonView GetSelfAddonById(ctx, addonId)

Required Parameters

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

Return type

AddonView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfAddonEnvByAddonId

[]AddonEnvironmentView GetSelfAddonEnvByAddonId(ctx, addonId)

Required Parameters

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

Return type

[]AddonEnvironmentView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfAddonTagsByAddonId

[]string GetSelfAddonTagsByAddonId(ctx, addonId)

Required Parameters

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

Return type

[]string

Authorization

No authorization required

HTTP request headers

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

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

GetSelfAddons

[]AddonView GetSelfAddons(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]AddonView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfAddonsLinkedToApplicationByAppId

[]AddonView GetSelfAddonsLinkedToApplicationByAppId(ctx, appId)

Required Parameters

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

Return type

[]AddonView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfAmount

DropCountView GetSelfAmount(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

DropCountView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfApplicationBranchesByAppId

[]string GetSelfApplicationBranchesByAppId(ctx, appId)

Required Parameters

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

Return type

[]string

Authorization

No authorization required

HTTP request headers

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

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

GetSelfApplicationByAppId

ApplicationView GetSelfApplicationByAppId(ctx, appId)

Required Parameters

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

Return type

ApplicationView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfApplicationDependenciesByAppId

[]ApplicationView GetSelfApplicationDependenciesByAppId(ctx, appId)

Required Parameters

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

Return type

[]ApplicationView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfApplicationDependenciesEnvByAppId

GetSelfApplicationDependenciesEnvByAppId(ctx, id, appId)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

GetSelfApplicationDependents

[]ApplicationView GetSelfApplicationDependents(ctx, appId)

Required Parameters

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

Return type

[]ApplicationView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfApplicationEnvByAppId

[]AddonEnvironmentView GetSelfApplicationEnvByAppId(ctx, appId)

Required Parameters

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

Return type

[]AddonEnvironmentView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfApplicationInstanceByAppAndInstanceId

SuperNovaInstanceView GetSelfApplicationInstanceByAppAndInstanceId(ctx, appId, instanceId)

Required Parameters

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

Return type

SuperNovaInstanceView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfApplicationInstancesByAppId

[]SuperNovaInstanceView GetSelfApplicationInstancesByAppId(ctx, appId, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appId	string
optional	*GetSelfApplicationInstancesByAppIdOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetSelfApplicationInstancesByAppIdOpts struct

Name	Type	Description	Notes

deploymentId | optional.String| | withDeleted | optional.String| |

Return type

[]SuperNovaInstanceView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfApplicationTagsByAppId

[]string GetSelfApplicationTagsByAppId(ctx, appId)

Required Parameters

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

Return type

[]string

Authorization

No authorization required

HTTP request headers

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

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

GetSelfApplications

[]ApplicationView GetSelfApplications(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]ApplicationView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfApplicationsLinkedToAddonByAddonId

[]ApplicationView GetSelfApplicationsLinkedToAddonByAddonId(ctx, addonId)

Required Parameters

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

Return type

[]ApplicationView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfCliTokens

[]CliTokenView GetSelfCliTokens(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetSelfCliTokensOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetSelfCliTokensOpts struct

Name	Type	Description	Notes
cliToken	optional.String

Return type

[]CliTokenView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfConsumer

OAuth1ConsumerView GetSelfConsumer(ctx, key)

Required Parameters

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

Return type

OAuth1ConsumerView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfConsumerSecret

SecretView GetSelfConsumerSecret(ctx, key)

Required Parameters

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

Return type

SecretView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfConsumers

GetSelfConsumers(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

GetSelfDefaultMethod

PaymentMethodView GetSelfDefaultMethod(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

PaymentMethodView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfEnvOfAddonsLinkedToApplicationByAppId

[]LinkedAddonEnvironmentView GetSelfEnvOfAddonsLinkedToApplicationByAppId(ctx, appId)

Required Parameters

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

Return type

[]LinkedAddonEnvironmentView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfExposedEnvByAppId

string GetSelfExposedEnvByAppId(ctx, appId)

Required Parameters

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

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

GetSelfFavouriteVhostByAppId

VhostView GetSelfFavouriteVhostByAppId(ctx, appId)

Required Parameters

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

Return type

VhostView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfInstancesForAllApps

SuperNovaInstanceMap GetSelfInstancesForAllApps(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

SuperNovaInstanceMap

Authorization

No authorization required

HTTP request headers

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

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

GetSelfInvoiceById

InvoiceRendering GetSelfInvoiceById(ctx, bid)

Required Parameters

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

Return type

InvoiceRendering

Authorization

No authorization required

HTTP request headers

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

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

GetSelfInvoices

[]InvoiceRendering GetSelfInvoices(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]InvoiceRendering

Authorization

No authorization required

HTTP request headers

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

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

GetSelfMonthlyInvoice

string GetSelfMonthlyInvoice(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

GetSelfPaymentInfo

PaymentInfoView GetSelfPaymentInfo(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

PaymentInfoView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfPaymentMethods

[]PaymentMethodView GetSelfPaymentMethods(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]PaymentMethodView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfPdfInvoiceById

GetSelfPdfInvoiceById(ctx, bid, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
bid	string
optional	*GetSelfPdfInvoiceByIdOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetSelfPdfInvoiceByIdOpts struct

Name	Type	Description	Notes

token | optional.String| |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/pdf

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

GetSelfPriceWithTax

PriceWithTaxInfo GetSelfPriceWithTax(ctx, price)

Required Parameters

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

Return type

PriceWithTaxInfo

Authorization

No authorization required

HTTP request headers

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

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

GetSelfRecurrentPayment

RecurrentPaymentView GetSelfRecurrentPayment(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

RecurrentPaymentView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfStripeToken

BraintreeToken GetSelfStripeToken(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

BraintreeToken

Authorization

No authorization required

HTTP request headers

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

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

GetSelfTokens

[]OAuth1AccessTokenView GetSelfTokens(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]OAuth1AccessTokenView

Authorization

No authorization required

HTTP request headers

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

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

GetSelfVhostByAppId

[]VhostView GetSelfVhostByAppId(ctx, appId)

Required Parameters

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

Return type

[]VhostView

Authorization

No authorization required

HTTP request headers

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

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

GetSshKeys

[]SshKeyView GetSshKeys(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]SshKeyView

Authorization

No authorization required

HTTP request headers

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

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

GetSummary

Summary GetSummary(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetSummaryOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetSummaryOpts struct

Name	Type	Description	Notes
full	optional.String

Return type

Summary

Authorization

No authorization required

HTTP request headers

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

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

GetUser

UserView GetUser(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

UserView

Authorization

No authorization required

HTTP request headers

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

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

LinkSelfAddonToApplicationByAppId

LinkSelfAddonToApplicationByAppId(ctx, appId)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

MarkSelfFavouriteVhostByAppId

VhostView MarkSelfFavouriteVhostByAppId(ctx, appId, vhostView)

Required Parameters

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

Return type

VhostView

Authorization

No authorization required

HTTP request headers

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

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

PreorderSelfAddon

InvoiceRendering PreorderSelfAddon(ctx, wannabeAddonProvision)

Required Parameters

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

Return type

InvoiceRendering

Authorization

No authorization required

HTTP request headers

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

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

ProvisionSelfAddon

AddonView ProvisionSelfAddon(ctx, wannabeAddonProvision)

Required Parameters

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

Return type

AddonView

Authorization

No authorization required

HTTP request headers

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

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

RedeploySelfApplicationByAppId

Message RedeploySelfApplicationByAppId(ctx, appId, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appId	string
optional	*RedeploySelfApplicationByAppIdOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RedeploySelfApplicationByAppIdOpts struct

Name	Type	Description	Notes

commit | optional.String| | useCache | optional.String| |

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

RemoveEmailAddress

Message RemoveEmailAddress(ctx, email)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

RemoveSelfApplicationEnvByAppIdAndEnvName

ApplicationView RemoveSelfApplicationEnvByAppIdAndEnvName(ctx, appId, envName)

Required Parameters

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

Return type

ApplicationView

Authorization

No authorization required

HTTP request headers

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

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

RemoveSelfVhostByAppId

Message RemoveSelfVhostByAppId(ctx, appId, domain)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

RemoveSshKey

Message RemoveSshKey(ctx, key)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

RenameAddon

AddonView RenameAddon(ctx, addonId, wannabeAddonProvision)

Required Parameters

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

Return type

AddonView

Authorization

No authorization required

HTTP request headers

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

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

RevokeAllTokens

Message RevokeAllTokens(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

RevokeToken

Message RevokeToken(ctx, token)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

SetSelfApplicationBranchByAppId

SetSelfApplicationBranchByAppId(ctx, appId, wannabeBranch)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

SetSelfBuildInstanceFlavorByAppId

SetSelfBuildInstanceFlavorByAppId(ctx, appId, wannabeBuildFlavor)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

SetSelfDefaultMethod

SetSelfDefaultMethod(ctx, paymentData)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

SetSelfMaxCreditsPerMonth

WannabeMaxCredits SetSelfMaxCreditsPerMonth(ctx, wannabeMaxCredits)

Required Parameters

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

Return type

WannabeMaxCredits

Authorization

No authorization required

HTTP request headers

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

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

SetUserAvatarFromString

UrlView SetUserAvatarFromString(ctx, wannabeAvatarSource)

Required Parameters

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

Return type

UrlView

Authorization

No authorization required

HTTP request headers

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

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

UndeploySelfApplicationByAppId

Message UndeploySelfApplicationByAppId(ctx, appId)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

UnlinkSelfddonFromApplicationByAppAndAddonId

UnlinkSelfddonFromApplicationByAppAndAddonId(ctx, appId, addonId)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

UnmarkSelfFavouriteVhostByAppId

UnmarkSelfFavouriteVhostByAppId(ctx, appId)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

UpdateSelfConsumer

OAuth1ConsumerView UpdateSelfConsumer(ctx, key, wannabeOAuth1Consumer)

Required Parameters

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

Return type

OAuth1ConsumerView

Authorization

No authorization required

HTTP request headers

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

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

UpdateSelfExposedEnvByAppId

Message UpdateSelfExposedEnvByAppId(ctx, appId, body)

Required Parameters

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

Return type

Message

Authorization

No authorization required

HTTP request headers

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

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

ValidateEmail

ValidateEmail(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*ValidateEmailOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ValidateEmailOpts struct

Name	Type	Description	Notes
validationKey	optional.String

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

ValidateMFA

ValidateMFA(ctx, kind, wannabeMfaCreds)

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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