Skip to content
This repository was archived by the owner on Mar 6, 2025. It is now read-only.

Latest commit

 

History

History
736 lines (400 loc) · 17.8 KB

ProductsApi.md

File metadata and controls

736 lines (400 loc) · 17.8 KB

\ProductsApi

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

Method HTTP request Description
BillOwner Post /vendor/apps/{addonId}/consumptions
EditApplicationConfiguration Put /vendor/apps/{addonId}
EndAddonMigration Put /vendor/apps/{addonId}/migration_callback
GetAddonProvider Get /products/addonproviders/{provider_id}
GetAddonProviderInfos Get /products/addonproviders/{provider_id}/informations
GetAddonProviderVersions Get /products/addonproviders/{provider_id}/versions
GetAddonProviders Get /products/addonproviders
GetApplicationInfo Get /vendor/apps/{addonId}
GetAvailableInstances Get /products/instances
GetAvailablePackages Get /products/packages
GetCountries Get /products/countries
GetCountryCodes Get /products/countrycodes
GetExcahngeRates Get /products/prices
GetFlavors Get /products/flavors
GetInstance Get /products/instances/{type}-{version}
GetMFAKinds Get /products/mfa_kinds
GetZones Get /products/zones
ListApps Get /vendor/apps
Logscollector Get /vendor/apps/{addonId}/logscollector
ProvisionOtherAddon Post /vendor/addons

BillOwner

BillOwner(ctx, addonId, wannabeAddonBilling)

Required Parameters

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

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]

EditApplicationConfiguration

AddonView EditApplicationConfiguration(ctx, addonId, wannabeAddonConfig)

Required Parameters

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

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]

EndAddonMigration

AddonView EndAddonMigration(ctx, addonId, wannabeAddonConfig, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
addonId string
wannabeAddonConfig WannabeAddonConfig
optional *EndAddonMigrationOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a EndAddonMigrationOpts struct

Name Type Description Notes

planId | optional.String| | region | optional.String| |

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]

GetAddonProvider

AddonProviderInfoFullView GetAddonProvider(ctx, providerId, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetAddonProviderOpts struct

Name Type Description Notes

orgaId | optional.String| |

Return type

AddonProviderInfoFullView

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]

GetAddonProviderInfos

string GetAddonProviderInfos(ctx, providerId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId 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]

GetAddonProviderVersions

string GetAddonProviderVersions(ctx, providerId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId 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]

GetAddonProviders

[]AddonProviderInfoFullView GetAddonProviders(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetAddonProvidersOpts struct

Name Type Description Notes
orgaId optional.String

Return type

[]AddonProviderInfoFullView

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]

GetApplicationInfo

AddonApplicationInfo GetApplicationInfo(ctx, addonId)

Required Parameters

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

Return type

AddonApplicationInfo

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]

GetAvailableInstances

[]AvailableInstanceView GetAvailableInstances(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetAvailableInstancesOpts struct

Name Type Description Notes
for_ optional.String

Return type

[]AvailableInstanceView

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]

GetAvailablePackages

[]PackageView GetAvailablePackages(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetAvailablePackagesOpts struct

Name Type Description Notes
coupon optional.String
orgaId optional.String
currency optional.String

Return type

[]PackageView

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]

GetCountries

string GetCountries(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]

GetCountryCodes

string GetCountryCodes(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]

GetExcahngeRates

[]DropPriceView GetExcahngeRates(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]DropPriceView

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]

GetFlavors

[]FlavorView GetFlavors(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetFlavorsOpts struct

Name Type Description Notes
context optional.String

Return type

[]FlavorView

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]

GetInstance

AvailableInstanceView GetInstance(ctx, type_, version, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetInstanceOpts struct

Name Type Description Notes

for_ | optional.String| | app | optional.String| |

Return type

AvailableInstanceView

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]

GetMFAKinds

[]string GetMFAKinds(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]

GetZones

[]ZoneView GetZones(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]ZoneView

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]

ListApps

[]AddonApplicationSummary ListApps(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ListAppsOpts struct

Name Type Description Notes
offset optional.Int32

Return type

[]AddonApplicationSummary

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]

Logscollector

Logscollector(ctx, addonId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
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]

ProvisionOtherAddon

ProvisionOtherAddon(ctx, wannabeInterAddonProvision)

Required Parameters

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

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]