❤
npm
Sign UpSign In

@datafire/clever_cloud

5.0.0 • Public • Published

@datafire/clever_cloud

Client library for Clever-Cloud

Installation and Usage

npm install --save @datafire/clever_cloud
let clever_cloud = require('@datafire/clever_cloud').create();

.then(data => {
  console.log(data);
});

Description

Public API for managing Clever-Cloud data and products

Actions

application.appId.environment.get

clever_cloud.application.appId.environment.get({
  "appId": ""
}, context)

Input

  • input object
    • appId required string
    • token string

Output

Output schema unknown

application.appId.environment.put

clever_cloud.application.appId.environment.put({
  "appId": ""
}, context)

Input

  • input object
    • appId required string
    • token string

Output

Output schema unknown

postAuthorize

Handled by our API.

clever_cloud.postAuthorize(null, context)

Input

This action has no parameters

Output

Output schema unknown

events.event_socket.get

Retrieve events as they come through a websocket connection. To have authorization, you have to send a { "message_type": "oauth", "authorization": "oauth authorization string" } message

clever_cloud.events.event_socket.get(null, context)

Input

This action has no parameters

Output

Output schema unknown

getGithub

clever_cloud.getGithub(null, context)

Input

This action has no parameters

Output

getGithubApplications

clever_cloud.getGithubApplications(null, context)

Input

This action has no parameters

Output

getGithubCallback

clever_cloud.getGithubCallback({}, context)

Input

  • input object
    • code string
    • state string
    • error string
    • error_description string
    • error_uri string
    • Cookie string

Output

Output schema unknown

getGithubEmails

clever_cloud.getGithubEmails(null, context)

Input

This action has no parameters

Output

  • output array
    • items string

getGithubKeys

clever_cloud.getGithubKeys(null, context)

Input

This action has no parameters

Output

  • output array

deleteGithubLink

clever_cloud.deleteGithubLink(null, context)

Input

This action has no parameters

Output

Output schema unknown

getGithubLink

clever_cloud.getGithubLink({}, context)

Input

  • input object
    • transactionId string: From GET /github
    • redirectUrl string

Output

Output schema unknown

getGithubLogin

clever_cloud.getGithubLogin({}, context)

Input

  • input object
    • redirectUrl string
    • fromAuthorize string

Output

Output schema unknown

postGithubRedeploy

clever_cloud.postGithubRedeploy({}, context)

Input

  • input object
    • User-Agent string
    • X-Github-Event string
    • X-Hub-Signature string

Output

Output schema unknown

getGithubSignup

clever_cloud.getGithubSignup({}, context)

Input

  • input object
    • redirectUrl string
    • fromAuthorize string

Output

Output schema unknown

postGithubSignup

clever_cloud.postGithubSignup({}, context)

Input

  • input object
    • transactionId string
    • name string
    • otherId string
    • otherEmail string
    • password string
    • autoLink string
    • terms string

Output

Output schema unknown

getGithubUsername

clever_cloud.getGithubUsername(null, context)

Input

This action has no parameters

Output

  • output string

logs.logs_chunked.appId.get

Retrieve logs as they come through a chunked, never-ending response

clever_cloud.logs.logs_chunked.appId.get({
  "appId": ""
}, context)

Input

  • input object
    • appId required string: Application Id
    • download boolean: Tell the user-agent to download the body as a file

Output

Output schema unknown

logs.logs_socket.appId.get

Retrieve logs as they come through a websocket connection. To have authorization, you have to send a { "message_type": "oauth", "authorization": "oauth authorization string" } message

clever_cloud.logs.logs_socket.appId.get({
  "appId": ""
}, context)

Input

  • input object
    • appId required string: Application Id
    • since string: Only fetch logs newer than this (ISO-8601 formatted) date
    • filter string: A pattern to filter with
    • deployment_id string: Only fetch logs emitted by this deployment

Output

Output schema unknown

logs.appId.get

Fetch the logs for a given application

clever_cloud.logs.appId.get({
  "appId": ""
}, context)

Input

  • input object
    • appId required string: Application Id
    • limit integer: Number of lines to return
    • order string (values: asc, desc): Logs order
    • after string: Lowest bound for logs date, ISO 8601
    • before string: Highest bounds for logs date, ISO 8601
    • filter string: A pattern to filter with
    • deployment_id string: Only fetch logs emitted by this deployment

Output

Output schema unknown

logs.appId.drains.get

Fetch the logs drains for a given application

clever_cloud.logs.appId.drains.get({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

Output schema unknown

logs.appId.drains.post

Add a log drain for a given application

clever_cloud.logs.appId.drains.post({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

Output schema unknown

logs.appId.drains._idOrUrl.delete

Delete the logs drain by id or url for a given application

clever_cloud.logs.appId.drains._idOrUrl.delete({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

Output schema unknown

logs.appId.drains._idOrUrl.get

Fetch the logs drain by id or url for a given application

clever_cloud.logs.appId.drains._idOrUrl.get({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

Output schema unknown

getNewsfeedsBlog

clever_cloud.getNewsfeedsBlog(null, context)

Input

This action has no parameters

Output

Output schema unknown

getNewsfeedEngineering

clever_cloud.getNewsfeedEngineering(null, context)

Input

This action has no parameters

Output

Output schema unknown

notifications.emailhooks.ownerId.get

list created e-mail hooks

clever_cloud.notifications.emailhooks.ownerId.get({
  "ownerId": ""
}, context)

Input

  • input object
    • ownerId required string

Output

Output schema unknown

notifications.emailhooks.ownerId.post

create a hook for e-mail notifications

clever_cloud.notifications.emailhooks.ownerId.post({
  "ownerId": ""
}, context)

Input

  • input object
    • ownerId required string

Output

Output schema unknown

notifications.emailhooks.ownerId._id.delete

delete an e-mail hook

clever_cloud.notifications.emailhooks.ownerId._id.delete({
  "ownerId": ""
}, context)

Input

  • input object
    • ownerId required string

Output

Output schema unknown

notifications.emailhooks.ownerId._id.put

edit an e-mail hook

clever_cloud.notifications.emailhooks.ownerId._id.put({
  "ownerId": ""
}, context)

Input

  • input object
    • ownerId required string

Output

Output schema unknown

notifications.info.events.get

list available events

clever_cloud.notifications.info.events.get(null, context)

Input

This action has no parameters

Output

Output schema unknown

notifications.info.webhookformats.get

list available webhook formats

clever_cloud.notifications.info.webhookformats.get(null, context)

Input

This action has no parameters

Output

Output schema unknown

notifications.webhooks.ownerId.get

list created hooks

clever_cloud.notifications.webhooks.ownerId.get({
  "ownerId": ""
}, context)

Input

  • input object
    • ownerId required string

Output

Output schema unknown

notifications.webhooks.ownerId.post

create a hook for notifications

clever_cloud.notifications.webhooks.ownerId.post({
  "ownerId": ""
}, context)

Input

  • input object
    • ownerId required string

Output

Output schema unknown

notifications.webhooks.ownerId._id.delete

delete a hook

clever_cloud.notifications.webhooks.ownerId._id.delete({
  "ownerId": ""
}, context)

Input

  • input object
    • ownerId required string

Output

Output schema unknown

notifications.webhooks.ownerId._id.put

edit a hook

clever_cloud.notifications.webhooks.ownerId._id.put({
  "ownerId": ""
}, context)

Input

  • input object
    • ownerId required string

Output

Output schema unknown

postOauthAccessToken

clever_cloud.postOauthAccessToken({}, context)

Input

  • input object
    • oauth_consumer_key string
    • oauth_token string
    • oauth_signature_method string
    • oauth_signature string
    • oauth_timestamp string
    • oauth_nonce string
    • oauth_version string
    • oauth_verifier string
    • oauth_callback string
    • oauth_token_secret string
    • oauth_callback_confirmed string

Output

Output schema unknown

oauth.access_token_query.post

clever_cloud.oauth.access_token_query.post({}, context)

Input

  • input object
    • oauth_consumer_key string
    • oauth_token string
    • oauth_signature_method string
    • oauth_signature string
    • oauth_timestamp string
    • oauth_nonce string
    • oauth_version string
    • oauth_verifier string
    • oauth_callback string
    • oauth_token_secret string
    • oauth_callback_confirmed string

Output

Output schema unknown

getOauthAuthorize

clever_cloud.getOauthAuthorize({}, context)

Input

  • input object
    • oauth_token string
    • Cookie string

Output

Output schema unknown

postOauthAuthorize

clever_cloud.postOauthAuthorize({}, context)

Input

  • input object
    • almighty string
    • access_organisations string
    • manage_organisations string
    • manage_organisations_services string
    • manage_organisations_applications string
    • manage_organisations_members string
    • access_organisations_bills string
    • access_organisations_credit_count string
    • access_organisations_consumption_statistics string
    • access_personal_information string
    • manage_personal_information string
    • manage_ssh_keys string
    • manage_services string
    • manage_applications string
    • access_bills string
    • access_credit_count string
    • access_consumption_statistics string
    • Cookie string

Output

Output schema unknown

postOauthRequestToken

clever_cloud.postOauthRequestToken({}, context)

Input

  • input object
    • oauth_consumer_key string
    • oauth_token string
    • oauth_signature_method string
    • oauth_signature string
    • oauth_timestamp string
    • oauth_nonce string
    • oauth_version string
    • oauth_verifier string
    • oauth_callback string
    • oauth_token_secret string
    • oauth_callback_confirmed string

Output

Output schema unknown

oauth.request_token_query.post

clever_cloud.oauth.request_token_query.post({}, context)

Input

  • input object
    • oauth_consumer_key string
    • oauth_token string
    • oauth_signature_method string
    • oauth_signature string
    • oauth_timestamp string
    • oauth_nonce string
    • oauth_version string
    • oauth_verifier string
    • oauth_callback string
    • oauth_token_secret string
    • oauth_callback_confirmed string

Output

Output schema unknown

getOauthRights

clever_cloud.getOauthRights(null, context)

Input

This action has no parameters

Output

getOrganisations

clever_cloud.getOrganisations({}, context)

Input

  • input object
    • user string

Output

postOrganisations

clever_cloud.postOrganisations({}, context)

Input

Output

deleteOrganisationsId

clever_cloud.deleteOrganisationsId({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

getOrganisationsId

clever_cloud.getOrganisationsId({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

putOrganisationsId

clever_cloud.putOrganisationsId({
  "id": ""
}, context)

Input

Output

getOrganisationsIdAddonproviders

clever_cloud.getOrganisationsIdAddonproviders({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

postOrganisationsIdAddonproviders

clever_cloud.postOrganisationsIdAddonproviders({
  "id": ""
}, context)

Input

Output

getOrganisationsIdAddonprovidersProviderId

clever_cloud.getOrganisationsIdAddonprovidersProviderId({
  "id": "",
  "providerId": ""
}, context)

Input

  • input object
    • id required string
    • providerId required string

Output

putOrganisationsIdAddonprovidersProviderId

clever_cloud.putOrganisationsIdAddonprovidersProviderId({
  "id": "",
  "providerId": ""
}, context)

Input

Output

getOrganisationsIdAddonprovidersProviderIdFeatures

clever_cloud.getOrganisationsIdAddonprovidersProviderIdFeatures({
  "id": "",
  "providerId": ""
}, context)

Input

  • input object
    • id required string
    • providerId required string

Output

postOrganisationsIdAddonprovidersProviderIdFeatures

clever_cloud.postOrganisationsIdAddonprovidersProviderIdFeatures({
  "id": "",
  "providerId": ""
}, context)

Input

  • input object

Output

deleteOrganisationsIdAddonprovidersProviderIdFeaturesFeatureId

clever_cloud.deleteOrganisationsIdAddonprovidersProviderIdFeaturesFeatureId({
  "id": "",
  "featureId": "",
  "providerId": ""
}, context)

Input

  • input object
    • id required string
    • featureId required string
    • providerId required string

Output

Output schema unknown

getOrganisationsIdAddonprovidersProviderIdPlans

clever_cloud.getOrganisationsIdAddonprovidersProviderIdPlans({
  "id": "",
  "providerId": ""
}, context)

Input

  • input object
    • id required string
    • providerId required string

Output

  • output array

postOrganisationsIdAddonprovidersProviderIdPlans

clever_cloud.postOrganisationsIdAddonprovidersProviderIdPlans({
  "id": "",
  "providerId": ""
}, context)

Input

  • input object
    • id required string
    • providerId required string
    • body WannabePlan

Output

deleteOrganisationsIdAddonprovidersProviderIdPlansPlanId

clever_cloud.deleteOrganisationsIdAddonprovidersProviderIdPlansPlanId({
  "id": "",
  "providerId": "",
  "planId": ""
}, context)

Input

  • input object
    • id required string
    • providerId required string
    • planId required string

Output

Output schema unknown

getOrganisationsIdAddonprovidersProviderIdPlansPlanId

clever_cloud.getOrganisationsIdAddonprovidersProviderIdPlansPlanId({
  "id": "",
  "providerId": "",
  "planId": ""
}, context)

Input

  • input object
    • id required string
    • providerId required string
    • planId required string

Output

putOrganisationsIdAddonprovidersProviderIdPlansPlanId

clever_cloud.putOrganisationsIdAddonprovidersProviderIdPlansPlanId({
  "id": "",
  "providerId": "",
  "planId": ""
}, context)

Input

  • input object
    • id required string
    • providerId required string
    • planId required string
    • body WannabePlan

Output

deleteOrganisationsIdAddonprovidersProviderIdPlansPlanIdFeaturesFeatureName

clever_cloud.deleteOrganisationsIdAddonprovidersProviderIdPlansPlanIdFeaturesFeatureName({
  "id": "",
  "featureName": "",
  "providerId": "",
  "planId": ""
}, context)

Input

  • input object
    • id required string
    • featureName required string
    • providerId required string
    • planId required string

Output

Output schema unknown

putOrganisationsIdAddonprovidersProviderIdPlansPlanIdFeaturesFeatureName

clever_cloud.putOrganisationsIdAddonprovidersProviderIdPlansPlanIdFeaturesFeatureName({
  "id": "",
  "featureName": "",
  "providerId": "",
  "planId": ""
}, context)

Input

  • input object
    • id required string
    • featureName required string
    • providerId required string
    • planId required string
    • body WannabePlanFeature

Output

Output schema unknown

organisations.id.addonproviders.providerId.sso.get

clever_cloud.organisations.id.addonproviders.providerId.sso.get({
  "providerId": "",
  "id": ""
}, context)

Input

  • input object
    • providerId required string
    • id required string

Output

getOrganisationsIdAddonprovidersProviderIdTags

clever_cloud.getOrganisationsIdAddonprovidersProviderIdTags({
  "id": "",
  "providerId": ""
}, context)

Input

  • input object
    • id required string
    • providerId required string

Output

  • output array
    • items string

postOrganisationsIdAddonprovidersProviderIdTesters

clever_cloud.postOrganisationsIdAddonprovidersProviderIdTesters({
  "id": "",
  "providerId": ""
}, context)

Input

  • input object
    • id required string
    • providerId required string

Output

Output schema unknown

getOrganisationsIdAddons

clever_cloud.getOrganisationsIdAddons({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

  • output array

postOrganisationsIdAddons

clever_cloud.postOrganisationsIdAddons({
  "id": ""
}, context)

Input

Output

organisations.id.addons.preorders.post

clever_cloud.organisations.id.addons.preorders.post({
  "id": "",
  "body": {
    "name": "",
    "payment": {
      "token": "",
      "type": ""
    },
    "plan": "",
    "providerId": "",
    "region": ""
  }
}, context)

Input

  • input object

Output

Output schema unknown

deleteOrganisationsIdAddonsAddonId

clever_cloud.deleteOrganisationsIdAddonsAddonId({
  "id": "",
  "addonId": ""
}, context)

Input

  • input object
    • id required string
    • addonId required string

Output

Output schema unknown

getOrganisationsIdAddonsAddonId

clever_cloud.getOrganisationsIdAddonsAddonId({
  "id": "",
  "addonId": ""
}, context)

Input

  • input object
    • id required string
    • addonId required string

Output

putOrganisationsIdAddonsAddonId

clever_cloud.putOrganisationsIdAddonsAddonId({
  "id": "",
  "addonId": ""
}, context)

Input

  • input object
    • id required string
    • addonId required string
    • body WannabeAddon

Output

getOrganisationsIdAddonsAddonIdApplications

clever_cloud.getOrganisationsIdAddonsAddonIdApplications({
  "id": "",
  "addonId": ""
}, context)

Input

  • input object
    • id required string
    • addonId required string

Output

getOrganisationsIdAddonsAddonIdEnv

clever_cloud.getOrganisationsIdAddonsAddonIdEnv({
  "id": "",
  "addonId": ""
}, context)

Input

  • input object
    • id required string
    • addonId required string

Output

putOrganisationsIdAddonsAddonIdPlan

clever_cloud.putOrganisationsIdAddonsAddonIdPlan({
  "id": "",
  "addonId": ""
}, context)

Input

  • input object
    • id required string
    • addonId required string
    • body WannabePlan

Output

organisations.id.addons.addonId.sso.get

clever_cloud.organisations.id.addons.addonId.sso.get({
  "id": "",
  "addonId": ""
}, context)

Input

  • input object
    • id required string
    • addonId required string

Output

getOrganisationsIdAddonsAddonIdTags

clever_cloud.getOrganisationsIdAddonsAddonIdTags({
  "id": "",
  "addonId": ""
}, context)

Input

  • input object
    • id required string
    • addonId required string

Output

  • output array
    • items string

deleteOrganisationsIdAddonsAddonIdTagsTag

clever_cloud.deleteOrganisationsIdAddonsAddonIdTagsTag({
  "id": "",
  "tag": "",
  "addonId": ""
}, context)

Input

  • input object
    • id required string
    • tag required string
    • addonId required string

Output

Output schema unknown

putOrganisationsIdAddonsAddonIdTagsTag

clever_cloud.putOrganisationsIdAddonsAddonIdTagsTag({
  "id": "",
  "tag": "",
  "addonId": ""
}, context)

Input

  • input object
    • id required string
    • tag required string
    • addonId required string
    • body Body

Output

Output schema unknown

getOrganisationsIdApplications

clever_cloud.getOrganisationsIdApplications({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

postOrganisationsIdApplications

Creates an application. If you want to create a Github app, you need to replace the oauthApp field with what you will find here: https://github.com/CleverCloud/doc.clever-cloud.com/issues/179

clever_cloud.postOrganisationsIdApplications({
  "id": ""
}, context)

Input

Output

deleteOrganisationsIdApplicationsAppId

clever_cloud.deleteOrganisationsIdApplicationsAppId({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string

Output

Output schema unknown

getOrganisationsIdApplicationsAppId

clever_cloud.getOrganisationsIdApplicationsAppId({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string

Output

putOrganisationsIdApplicationsAppId

clever_cloud.putOrganisationsIdApplicationsAppId({
  "id": "",
  "appId": ""
}, context)

Input

Output

getOrganisationsIdApplicationsAppIdAddons

clever_cloud.getOrganisationsIdApplicationsAppIdAddons({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string

Output

  • output array

postOrganisationsIdApplicationsAppIdAddons

clever_cloud.postOrganisationsIdApplicationsAppIdAddons({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • body Body

Output

Output schema unknown

getOrganisationsIdApplicationsAppIdAddonsEnv

clever_cloud.getOrganisationsIdApplicationsAppIdAddonsEnv({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string

Output

  • output array

deleteOrganisationsIdApplicationsAppIdAddonsAddonId

clever_cloud.deleteOrganisationsIdApplicationsAppIdAddonsAddonId({
  "id": "",
  "appId": "",
  "addonId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • addonId required string

Output

Output schema unknown

organisations.id.applications.appId.branch.put

clever_cloud.organisations.id.applications.appId.branch.put({
  "appId": "",
  "id": ""
}, context)

Input

  • input object
    • appId required string
    • id required string

Output

Output schema unknown

organisations.id.applications.appId.branches.get

clever_cloud.organisations.id.applications.appId.branches.get({
  "appId": "",
  "id": ""
}, context)

Input

  • input object
    • appId required string
    • id required string

Output

Output schema unknown

getOrganisationsIdApplicationsAppIdDependencies

clever_cloud.getOrganisationsIdApplicationsAppIdDependencies({
  "appId": "",
  "id": ""
}, context)

Input

  • input object
    • appId required string
    • id required string

Output

organisations.id.applications.appId.dependencies.env.get

clever_cloud.organisations.id.applications.appId.dependencies.env.get({
  "appId": "",
  "id": ""
}, context)

Input

  • input object
    • appId required string
    • id required string

Output

deleteOrganisationsIdApplicationsAppIdDependenciesDependencyId

clever_cloud.deleteOrganisationsIdApplicationsAppIdDependenciesDependencyId({
  "dependencyId": "",
  "appId": "",
  "id": ""
}, context)

Input

  • input object
    • dependencyId required string
    • appId required string
    • id required string

Output

Output schema unknown

putOrganisationsIdApplicationsAppIdDependenciesDependencyId

clever_cloud.putOrganisationsIdApplicationsAppIdDependenciesDependencyId({
  "dependencyId": "",
  "appId": "",
  "id": ""
}, context)

Input

  • input object
    • dependencyId required string
    • appId required string
    • id required string
    • body Body

Output

Output schema unknown

getOrganisationsIdApplicationsAppIdDependents

clever_cloud.getOrganisationsIdApplicationsAppIdDependents({
  "appId": "",
  "id": ""
}, context)

Input

  • input object
    • appId required string
    • id required string

Output

getOrganisationsIdApplicationsAppIdDeployments

clever_cloud.getOrganisationsIdApplicationsAppIdDeployments({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • limit string
    • offset string
    • action string

Output

deleteOrganisationsIdApplicationsAppIdDeploymentsDeploymentIdInstances

clever_cloud.deleteOrganisationsIdApplicationsAppIdDeploymentsDeploymentIdInstances({
  "id": "",
  "appId": "",
  "deploymentId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • deploymentId required string

Output

Output schema unknown

getOrganisationsIdApplicationsAppIdEnv

clever_cloud.getOrganisationsIdApplicationsAppIdEnv({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string

Output

putOrganisationsIdApplicationsAppIdEnv

clever_cloud.putOrganisationsIdApplicationsAppIdEnv({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • body WannabeEnv

Output

deleteOrganisationsIdApplicationsAppIdEnvEnvName

clever_cloud.deleteOrganisationsIdApplicationsAppIdEnvEnvName({
  "id": "",
  "appId": "",
  "envName": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • envName required string

Output

Output schema unknown

putOrganisationsIdApplicationsAppIdEnvEnvName

clever_cloud.putOrganisationsIdApplicationsAppIdEnvEnvName({
  "id": "",
  "appId": "",
  "envName": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • envName required string
    • body WannabeEnv

Output

organisations.id.applications.appId.exposed_env.get

clever_cloud.organisations.id.applications.appId.exposed_env.get({
  "appId": "",
  "id": ""
}, context)

Input

  • input object
    • appId required string
    • id required string

Output

Output schema unknown

organisations.id.applications.appId.exposed_env.put

clever_cloud.organisations.id.applications.appId.exposed_env.put({
  "appId": "",
  "id": ""
}, context)

Input

  • input object
    • appId required string
    • id required string

Output

deleteOrganisationsIdApplicationsAppIdInstances

clever_cloud.deleteOrganisationsIdApplicationsAppIdInstances({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string

Output

Output schema unknown

getOrganisationsIdApplicationsAppIdInstances

clever_cloud.getOrganisationsIdApplicationsAppIdInstances({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string

Output

postOrganisationsIdApplicationsAppIdInstances

clever_cloud.postOrganisationsIdApplicationsAppIdInstances({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • commit string

Output

Output schema unknown

organisations.id.applications.appId.instances.instanceId.get

clever_cloud.organisations.id.applications.appId.instances.instanceId.get({
  "instanceId": "",
  "appId": "",
  "id": ""
}, context)

Input

  • input object
    • instanceId required string
    • appId required string
    • id required string

Output

getOrganisationsIdApplicationsAppIdTags

clever_cloud.getOrganisationsIdApplicationsAppIdTags({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string

Output

  • output array
    • items string

deleteOrganisationsIdApplicationsAppIdTagsTag

clever_cloud.deleteOrganisationsIdApplicationsAppIdTagsTag({
  "id": "",
  "appId": "",
  "tag": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • tag required string

Output

Output schema unknown

putOrganisationsIdApplicationsAppIdTagsTag

clever_cloud.putOrganisationsIdApplicationsAppIdTagsTag({
  "id": "",
  "appId": "",
  "tag": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • tag required string
    • body Body

Output

Output schema unknown

getOrganisationsIdApplicationsAppIdVhosts

clever_cloud.getOrganisationsIdApplicationsAppIdVhosts({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string

Output

  • output array

deleteOrganisationsIdApplicationsAppIdVhostsFavourite

clever_cloud.deleteOrganisationsIdApplicationsAppIdVhostsFavourite({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string

Output

Output schema unknown

getOrganisationsIdApplicationsAppIdVhostsFavourite

clever_cloud.getOrganisationsIdApplicationsAppIdVhostsFavourite({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string

Output

putOrganisationsIdApplicationsAppIdVhostsFavourite

clever_cloud.putOrganisationsIdApplicationsAppIdVhostsFavourite({
  "id": "",
  "appId": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • body Vhost

Output

Output schema unknown

deleteOrganisationsIdApplicationsAppIdVhostsDomain

clever_cloud.deleteOrganisationsIdApplicationsAppIdVhostsDomain({
  "id": "",
  "appId": "",
  "domain": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • domain required string

Output

Output schema unknown

putOrganisationsIdApplicationsAppIdVhostsDomain

clever_cloud.putOrganisationsIdApplicationsAppIdVhostsDomain({
  "id": "",
  "appId": "",
  "domain": ""
}, context)

Input

  • input object
    • id required string
    • appId required string
    • domain required string
    • body Vhost

Output

Output schema unknown

putOrganisationsIdAvatar

If you want to upload an image from your computer, send the image in the body of the request without anything else.

clever_cloud.putOrganisationsIdAvatar({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

getOrganisationsIdConsumers

clever_cloud.getOrganisationsIdConsumers({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

postOrganisationsIdConsumers

clever_cloud.postOrganisationsIdConsumers({
  "id": ""
}, context)

Input

Output

Output schema unknown

deleteOrganisationsIdConsumersKey

clever_cloud.deleteOrganisationsIdConsumersKey({
  "id": "",
  "key": ""
}, context)

Input

  • input object
    • id required string
    • key required string

Output

Output schema unknown

getOrganisationsIdConsumersKey

clever_cloud.getOrganisationsIdConsumersKey({
  "id": "",
  "key": ""
}, context)

Input

  • input object
    • id required string
    • key required string

Output

putOrganisationsIdConsumersKey

clever_cloud.putOrganisationsIdConsumersKey({
  "id": "",
  "key": ""
}, context)

Input

Output

Output schema unknown

getOrganisationsIdConsumersKeySecret

clever_cloud.getOrganisationsIdConsumersKeySecret({
  "id": "",
  "key": ""
}, context)

Input

  • input object
    • id required string
    • key required string

Output

getOrganisationsIdConsumptions

clever_cloud.getOrganisationsIdConsumptions({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • appId string
    • from string
    • to string

Output

getOrganisationsIdCredits

clever_cloud.getOrganisationsIdCredits({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

getOrganisationsIdInstances

clever_cloud.getOrganisationsIdInstances({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

  • output object

getOrganisationsIdMembers

clever_cloud.getOrganisationsIdMembers({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

postOrganisationsIdMembers

clever_cloud.postOrganisationsIdMembers({
  "id": ""
}, context)

Input

  • input object

Output

Output schema unknown

deleteOrganisationsIdMembersUserId

clever_cloud.deleteOrganisationsIdMembersUserId({
  "id": "",
  "userId": ""
}, context)

Input

  • input object
    • id required string
    • userId required string

Output

Output schema unknown

putOrganisationsIdMembersUserId

clever_cloud.putOrganisationsIdMembersUserId({
  "id": "",
  "userId": ""
}, context)

Input

  • input object

Output

Output schema unknown

getOrganisationsIdPaymentInfo

clever_cloud.getOrganisationsIdPaymentInfo({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

getOrganisationsIdPaymentsBillings

clever_cloud.getOrganisationsIdPaymentsBillings({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

postOrganisationsIdPaymentsBillings

clever_cloud.postOrganisationsIdPaymentsBillings({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

organisations.id.payments.billings.unpaid.get

clever_cloud.organisations.id.payments.billings.unpaid.get({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

deleteOrganisationsIdPaymentsBillingsBid

clever_cloud.deleteOrganisationsIdPaymentsBillingsBid({
  "id": "",
  "bid": ""
}, context)

Input

  • input object
    • id required string
    • bid required string

Output

Output schema unknown

getOrganisationsIdPaymentsBillingsBid

clever_cloud.getOrganisationsIdPaymentsBillingsBid({
  "id": "",
  "bid": ""
}, context)

Input

  • input object
    • id required string
    • bid required string

Output

Output schema unknown

putOrganisationsIdPaymentsBillingsBid

clever_cloud.putOrganisationsIdPaymentsBillingsBid({
  "id": "",
  "bid": ""
}, context)

Input

  • input object
    • id required string
    • bid required string

Output

Output schema unknown

getOrganisationsIdPaymentsBillingsBidPdf

clever_cloud.getOrganisationsIdPaymentsBillingsBidPdf({
  "id": "",
  "bid": ""
}, context)

Input

  • input object
    • id required string
    • bid required string
    • token string

Output

Output schema unknown

getOrganisationsIdPaymentsFullPricePrice

clever_cloud.getOrganisationsIdPaymentsFullPricePrice({
  "id": "",
  "price": ""
}, context)

Input

  • input object
    • id required string
    • price required string

Output

Output schema unknown

organisations.id.payments.methods.get

clever_cloud.organisations.id.payments.methods.get({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

organisations.id.payments.methods.post

clever_cloud.organisations.id.payments.methods.post({
  "id": "",
  "body": null
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

organisations.id.payments.methods.default.get

clever_cloud.organisations.id.payments.methods.default.get({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

organisations.id.payments.methods.default.put

clever_cloud.organisations.id.payments.methods.default.put({
  "id": "",
  "body": {
    "token": "",
    "type": ""
  }
}, context)

Input

  • input object

Output

Output schema unknown

organisations.id.payments.methods.mId.delete

clever_cloud.organisations.id.payments.methods.mId.delete({
  "mId": "",
  "id": ""
}, context)

Input

  • input object
    • mId required string
    • id required string

Output

Output schema unknown

organisations.id.payments.monthlyinvoice.get

clever_cloud.organisations.id.payments.monthlyinvoice.get({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

organisations.id.payments.monthlyinvoice.maxcredit.put

clever_cloud.organisations.id.payments.monthlyinvoice.maxcredit.put({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

deleteOrganisationsIdPaymentsRecurring

clever_cloud.deleteOrganisationsIdPaymentsRecurring({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

organisations.id.payments.recurring.get

clever_cloud.organisations.id.payments.recurring.get({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

organisations.id.payments.tokens.bt.get

clever_cloud.organisations.id.payments.tokens.bt.get({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

getPasswordForgotten

clever_cloud.getPasswordForgotten(null, context)

Input

This action has no parameters

Output

Output schema unknown

postPasswordForgotten

clever_cloud.postPasswordForgotten({}, context)

Input

  • input object
    • login string
    • drop_tokens string
    • TesterPass string

Output

Output schema unknown

getPasswordForgottenKey

clever_cloud.getPasswordForgottenKey({
  "key": ""
}, context)

Input

  • input object
    • key required string

Output

Output schema unknown

postPasswordForgottenKey

clever_cloud.postPasswordForgottenKey({
  "key": ""
}, context)

Input

  • input object
    • key required string
    • pass string
    • pass2 string

Output

Output schema unknown

getPaymentsCouponsName

clever_cloud.getPaymentsCouponsName({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

Output schema unknown

getPaymentsProviders

clever_cloud.getPaymentsProviders(null, context)

Input

This action has no parameters

Output

getPaymentsTokensBt

clever_cloud.getPaymentsTokensBt(null, context)

Input

This action has no parameters

Output

Output schema unknown

getPaymentsWebhooksBt

clever_cloud.getPaymentsWebhooksBt({}, context)

Input

  • input object
    • bt_challenge string

Output

Output schema unknown

postPaymentsBidEndBt

clever_cloud.postPaymentsBidEndBt({
  "bid": ""
}, context)

Input

  • input object
    • bid required string

Output

Output schema unknown

getProductsAddonProviders

clever_cloud.getProductsAddonProviders(null, context)

Input

This action has no parameters

Output

getProductsAddonProvidersProviderId

clever_cloud.getProductsAddonProvidersProviderId({
  "provider_id": ""
}, context)

Input

  • input object
    • provider_id required string

Output

getProductsCountries

clever_cloud.getProductsCountries(null, context)

Input

This action has no parameters

Output

getProductsCountrycodes

clever_cloud.getProductsCountrycodes(null, context)

Input

This action has no parameters

Output

getProductsInstances

clever_cloud.getProductsInstances({}, context)

Input

  • input object
    • for string

Output

getProductsInstancesTypeVersion

clever_cloud.getProductsInstancesTypeVersion({
  "version": "",
  "type: [^-]+": ""
}, context)

Input

  • input object
    • version required string
    • for string
    • app string
    • type: [^-]+ required string

Output

products.mfa_kinds.get

clever_cloud.products.mfa_kinds.get(null, context)

Input

This action has no parameters

Output

Output schema unknown

getProductsPackages

clever_cloud.getProductsPackages({}, context)

Input

  • input object
    • coupon string
    • orgaId string
    • currency string

Output

Output schema unknown

getProductsPrices

clever_cloud.getProductsPrices(null, context)

Input

This action has no parameters

Output

Output schema unknown

getProductsZones

clever_cloud.getProductsZones(null, context)

Input

This action has no parameters

Output

  • output array

deleteSelf

clever_cloud.deleteSelf(null, context)

Input

This action has no parameters

Output

Output schema unknown

getSelf

Get information about yourself

clever_cloud.getSelf(null, context)

Input

This action has no parameters

Output

putSelf

clever_cloud.putSelf({}, context)

Input

Output

Output schema unknown

getSelfAddons

Get all the addons

clever_cloud.getSelfAddons(null, context)

Input

This action has no parameters

Output

  • output array

postSelfAddons

clever_cloud.postSelfAddons({}, context)

Input

Output

Output schema unknown

self.addons.preorders.post

clever_cloud.self.addons.preorders.post({
  "body": {
    "name": "",
    "payment": {
      "token": "",
      "type": ""
    },
    "plan": "",
    "providerId": "",
    "region": ""
  }
}, context)

Input

Output

Output schema unknown

deleteSelfAddonsAddonId

clever_cloud.deleteSelfAddonsAddonId({
  "addonId": ""
}, context)

Input

  • input object
    • addonId required string

Output

Output schema unknown

getSelfAddonsAddonId

Get a specific addon

clever_cloud.getSelfAddonsAddonId({
  "addonId": ""
}, context)

Input

  • input object
    • addonId required string

Output

putSelfAddonsAddonId

clever_cloud.putSelfAddonsAddonId({
  "addonId": ""
}, context)

Input

Output

Output schema unknown

getSelfAddonsAddonIdApplications

clever_cloud.getSelfAddonsAddonIdApplications({
  "addonId": ""
}, context)

Input

  • input object
    • addonId required string

Output

getSelfAddonsAddonIdEnv

clever_cloud.getSelfAddonsAddonIdEnv({
  "addonId": ""
}, context)

Input

  • input object
    • addonId required string

Output

putSelfAddonsAddonIdPlan

clever_cloud.putSelfAddonsAddonIdPlan({
  "addonId": ""
}, context)

Input

  • input object

Output

Output schema unknown

getSelfAddonsAddonIdSso

clever_cloud.getSelfAddonsAddonIdSso({
  "addonId": ""
}, context)

Input

  • input object
    • addonId required string

Output

getSelfAddonsAddonIdTags

clever_cloud.getSelfAddonsAddonIdTags({
  "addonId": ""
}, context)

Input

  • input object
    • addonId required string

Output

  • output array
    • items string

deleteSelfAddonsAddonIdTagsTag

clever_cloud.deleteSelfAddonsAddonIdTagsTag({
  "tag": "",
  "addonId": ""
}, context)

Input

  • input object
    • tag required string
    • addonId required string

Output

Output schema unknown

putSelfAddonsAddonIdTagsTag

clever_cloud.putSelfAddonsAddonIdTagsTag({
  "tag": "",
  "addonId": ""
}, context)

Input

  • input object
    • tag required string
    • addonId required string
    • body Body

Output

Output schema unknown

getSelfApplications

clever_cloud.getSelfApplications(null, context)

Input

This action has no parameters

Output

postSelfApplications

Creates an application. If you want to create a Github app, you need to replace the oauthApp field with what you will find here: https://github.com/CleverCloud/doc.clever-cloud.com/issues/179

clever_cloud.postSelfApplications({}, context)

Input

Output

Output schema unknown

deleteSelfApplicationsAppId

clever_cloud.deleteSelfApplicationsAppId({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

Output schema unknown

getSelfApplicationsAppId

clever_cloud.getSelfApplicationsAppId({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

putSelfApplicationsAppId

clever_cloud.putSelfApplicationsAppId({
  "appId": ""
}, context)

Input

Output

Output schema unknown

getSelfApplicationsAppIdAddons

clever_cloud.getSelfApplicationsAppIdAddons({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

  • output array

postSelfApplicationsAppIdAddons

clever_cloud.postSelfApplicationsAppIdAddons({
  "appId": ""
}, context)

Input

  • input object
    • appId required string
    • body Body

Output

Output schema unknown

getSelfApplicationsAppIdAddonsEnv

clever_cloud.getSelfApplicationsAppIdAddonsEnv({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

  • output array

deleteSelfApplicationsAppIdAddonsAddonId

clever_cloud.deleteSelfApplicationsAppIdAddonsAddonId({
  "appId": "",
  "addonId": ""
}, context)

Input

  • input object
    • appId required string
    • addonId required string

Output

Output schema unknown

self.applications.appId.branch.put

clever_cloud.self.applications.appId.branch.put({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

Output schema unknown

self.applications.appId.branches.get

clever_cloud.self.applications.appId.branches.get({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

Output schema unknown

getSelfApplicationsAppIdDependencies

clever_cloud.getSelfApplicationsAppIdDependencies({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

self.applications.appId.dependencies.env.get

clever_cloud.self.applications.appId.dependencies.env.get({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

deleteSelfApplicationsAppIdDependenciesDependencyId

clever_cloud.deleteSelfApplicationsAppIdDependenciesDependencyId({
  "dependencyId": "",
  "appId": ""
}, context)

Input

  • input object
    • dependencyId required string
    • appId required string

Output

Output schema unknown

getSelfApplicationsAppIdDependenciesDependencyId

clever_cloud.getSelfApplicationsAppIdDependenciesDependencyId({
  "dependencyId": "",
  "appId": ""
}, context)

Input

Output

Output schema unknown

getSelfApplicationsAppIdDependents

clever_cloud.getSelfApplicationsAppIdDependents({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

getSelfApplicationsAppIdDeployments

clever_cloud.getSelfApplicationsAppIdDeployments({
  "appId": ""
}, context)

Input

  • input object
    • appId required string
    • limit string
    • offset string
    • action string

Output

deleteSelfApplicationsAppIdDeploymentsDeploymentIdInstances

clever_cloud.deleteSelfApplicationsAppIdDeploymentsDeploymentIdInstances({
  "appId": "",
  "deploymentId": ""
}, context)

Input

  • input object
    • appId required string
    • deploymentId required string

Output

Output schema unknown

getSelfApplicationsAppIdEnv

clever_cloud.getSelfApplicationsAppIdEnv({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

putSelfApplicationsAppIdEnv

clever_cloud.putSelfApplicationsAppIdEnv({
  "appId": ""
}, context)

Input

  • input object

Output

Output schema unknown

deleteSelfApplicationsAppIdEnvEnvName

clever_cloud.deleteSelfApplicationsAppIdEnvEnvName({
  "appId": "",
  "envName": ""
}, context)

Input

  • input object
    • appId required string
    • envName required string

Output

Output schema unknown

putSelfApplicationsAppIdEnvEnvName

clever_cloud.putSelfApplicationsAppIdEnvEnvName({
  "appId": "",
  "envName": ""
}, context)

Input

  • input object
    • appId required string
    • envName required string
    • body WannabeEnv

Output

Output schema unknown

self.applications.appId.exposed_env.get

clever_cloud.self.applications.appId.exposed_env.get({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

Output schema unknown

self.applications.appId.exposed_env.put

clever_cloud.self.applications.appId.exposed_env.put({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

Output schema unknown

deleteSelfApplicationsAppIdInstances

clever_cloud.deleteSelfApplicationsAppIdInstances({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

Output schema unknown

getSelfApplicationsAppIdInstances

clever_cloud.getSelfApplicationsAppIdInstances({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

postSelfApplicationsAppIdInstances

clever_cloud.postSelfApplicationsAppIdInstances({
  "appId": ""
}, context)

Input

  • input object
    • appId required string
    • commit string

Output

Output schema unknown

self.applications.appId.instances.instanceId.get

clever_cloud.self.applications.appId.instances.instanceId.get({
  "instanceId": "",
  "appId": ""
}, context)

Input

  • input object
    • instanceId required string
    • appId required string

Output

getSelfApplicationsAppIdTags

clever_cloud.getSelfApplicationsAppIdTags({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

  • output array
    • items string

deleteSelfApplicationsAppIdTagsTag

clever_cloud.deleteSelfApplicationsAppIdTagsTag({
  "appId": "",
  "tag": ""
}, context)

Input

  • input object
    • appId required string
    • tag required string

Output

Output schema unknown

putSelfApplicationsAppIdTagsTag

clever_cloud.putSelfApplicationsAppIdTagsTag({
  "appId": "",
  "tag": ""
}, context)

Input

  • input object
    • appId required string
    • tag required string
    • body Body

Output

Output schema unknown

getSelfApplicationsAppIdVhosts

clever_cloud.getSelfApplicationsAppIdVhosts({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

  • output array

deleteSelfApplicationsAppIdVhostsFavourite

clever_cloud.deleteSelfApplicationsAppIdVhostsFavourite({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

Output schema unknown

getSelfApplicationsAppIdVhostsFavourite

clever_cloud.getSelfApplicationsAppIdVhostsFavourite({
  "appId": ""
}, context)

Input

  • input object
    • appId required string

Output

putSelfApplicationsAppIdVhostsFavourite

clever_cloud.putSelfApplicationsAppIdVhostsFavourite({
  "appId": ""
}, context)

Input

  • input object
    • appId required string
    • body Vhost

Output

Output schema unknown

deleteSelfApplicationsAppIdVhostsDomain

clever_cloud.deleteSelfApplicationsAppIdVhostsDomain({
  "appId": "",
  "domain": ""
}, context)

Input

  • input object
    • appId required string
    • domain required string

Output

Output schema unknown

putSelfApplicationsAppIdVhostsDomain

clever_cloud.putSelfApplicationsAppIdVhostsDomain({
  "appId": "",
  "domain": ""
}, context)

Input

  • input object
    • appId required string
    • domain required string
    • body Vhost

Output

Output schema unknown

putSelfAvatar

clever_cloud.putSelfAvatar({}, context)

Input

Output

Output schema unknown

putSelfChangePassword

clever_cloud.putSelfChangePassword(null, context)

Input

This action has no parameters

Output

getSelfConfirmationEmail

clever_cloud.getSelfConfirmationEmail(null, context)

Input

This action has no parameters

Output

Output schema unknown

getSelfConsumers

clever_cloud.getSelfConsumers(null, context)

Input

This action has no parameters

Output

postSelfConsumers

clever_cloud.postSelfConsumers({}, context)

Input

Output

Output schema unknown

deleteSelfConsumersKey

clever_cloud.deleteSelfConsumersKey({
  "key": ""
}, context)

Input

  • input object
    • key required string

Output

Output schema unknown

getSelfConsumersKey

clever_cloud.getSelfConsumersKey({
  "key": ""
}, context)

Input

  • input object
    • key required string

Output

putSelfConsumersKey

clever_cloud.putSelfConsumersKey({
  "key": ""
}, context)

Input

Output

Output schema unknown

getSelfConsumersKeySecret

clever_cloud.getSelfConsumersKeySecret({
  "key": ""
}, context)

Input

  • input object
    • key required string

Output

getSelfConsumptions

clever_cloud.getSelfConsumptions({}, context)

Input

  • input object
    • appId string
    • from string
    • to string

Output

getSelfCredits

clever_cloud.getSelfCredits(null, context)

Input

This action has no parameters

Output

getSelfEmails

clever_cloud.getSelfEmails(null, context)

Input

This action has no parameters

Output

  • output array
    • items string

deleteSelfEmailsEmail

clever_cloud.deleteSelfEmailsEmail({
  "email": ""
}, context)

Input

  • input object
    • email required string

Output

Output schema unknown

putSelfEmailsEmail

clever_cloud.putSelfEmailsEmail({
  "email": ""
}, context)

Input

  • input object
    • email required string
    • body Body

Output

Output schema unknown

getSelfId

clever_cloud.getSelfId(null, context)

Input

This action has no parameters

Output

  • output string

getSelfInstances

clever_cloud.getSelfInstances(null, context)

Input

This action has no parameters

Output

getSelfKeys

clever_cloud.getSelfKeys(null, context)

Input

This action has no parameters

Output

  • output array

deleteSelfKeysKey

clever_cloud.deleteSelfKeysKey({
  "key": ""
}, context)

Input

  • input object
    • key required string

Output

Output schema unknown

putSelfKeysKey

clever_cloud.putSelfKeysKey({
  "key": ""
}, context)

Input

  • input object
    • key required string
    • body Body

Output

Output schema unknown

self.mfa.kind.delete

clever_cloud.self.mfa.kind.delete({
  "kind": ""
}, context)

Input

  • input object
    • kind required string

Output

Output schema unknown

self.mfa.kind.post

clever_cloud.self.mfa.kind.post({
  "kind": ""
}, context)

Input

  • input object
    • kind required string

Output

Output schema unknown

self.mfa.kind.put

clever_cloud.self.mfa.kind.put({
  "kind": ""
}, context)

Input

  • input object
    • kind required string

Output

Output schema unknown

self.mfa.kind.backupcodes.get

clever_cloud.self.mfa.kind.backupcodes.get({
  "kind": ""
}, context)

Input

  • input object
    • kind required string

Output

Output schema unknown

self.mfa.kind.confirmation.post

clever_cloud.self.mfa.kind.confirmation.post({
  "kind": ""
}, context)

Input

  • input object
    • kind required string

Output

Output schema unknown

getSelfPaymentInfo

clever_cloud.getSelfPaymentInfo(null, context)

Input

This action has no parameters

Output

Output schema unknown

getSelfPaymentsBillings

clever_cloud.getSelfPaymentsBillings(null, context)

Input

This action has no parameters

Output

Output schema unknown

postSelfPaymentsBillings

clever_cloud.postSelfPaymentsBillings(null, context)

Input

This action has no parameters

Output

Output schema unknown

deleteSelfPaymentsBillingsBid

clever_cloud.deleteSelfPaymentsBillingsBid({
  "bid": ""
}, context)

Input

  • input object
    • bid required string

Output

Output schema unknown

getSelfPaymentsBillingsBid

clever_cloud.getSelfPaymentsBillingsBid({
  "bid": ""
}, context)

Input

  • input object
    • bid required string

Output

Output schema unknown

putSelfPaymentsBillingsBid

clever_cloud.putSelfPaymentsBillingsBid({
  "bid": ""
}, context)

Input

  • input object
    • bid required string

Output

Output schema unknown

getSelfPaymentsBillingsBidPdf

clever_cloud.getSelfPaymentsBillingsBidPdf({
  "bid": ""
}, context)

Input

  • input object
    • bid required string
    • token string

Output

Output schema unknown

getSelfPaymentsFullpricePrice

clever_cloud.getSelfPaymentsFullpricePrice({
  "price": ""
}, context)

Input

  • input object
    • price required string

Output

Output schema unknown

getSelfPaymentsMethods

clever_cloud.getSelfPaymentsMethods(null, context)

Input

This action has no parameters

Output

Output schema unknown

postSelfPaymentsMethods

clever_cloud.postSelfPaymentsMethods(null, context)

Input

This action has no parameters

Output

Output schema unknown

self.payments.methods.default.get

clever_cloud.self.payments.methods.default.get(null, context)

Input

This action has no parameters

Output

Output schema unknown

self.payments.methods.default.put

clever_cloud.self.payments.methods.default.put(null, context)

Input

This action has no parameters

Output

Output schema unknown

deleteSelfPaymentsMethodsMId

clever_cloud.deleteSelfPaymentsMethodsMId({
  "mId": ""
}, context)

Input

  • input object
    • mId required string

Output

Output schema unknown

self.payments.monthlyinvoice.get

clever_cloud.self.payments.monthlyinvoice.get(null, context)

Input

This action has no parameters

Output

Output schema unknown

self.payments.monthlyinvoice.maxcredit.put

clever_cloud.self.payments.monthlyinvoice.maxcredit.put(null, context)

Input

This action has no parameters

Output

Output schema unknown

deleteSelfPaymentsRecurring

clever_cloud.deleteSelfPaymentsRecurring(null, context)

Input

This action has no parameters

Output

Output schema unknown

self.payments.recurring.get

clever_cloud.self.payments.recurring.get(null, context)

Input

This action has no parameters

Output

Output schema unknown

self.payments.tokens.bt.get

clever_cloud.self.payments.tokens.bt.get(null, context)

Input

This action has no parameters

Output

Output schema unknown

deleteSelfTokens

clever_cloud.deleteSelfTokens(null, context)

Input

This action has no parameters

Output

Output schema unknown

getSelfTokens

clever_cloud.getSelfTokens(null, context)

Input

This action has no parameters

Output

  • output array

deleteSelfTokensToken

clever_cloud.deleteSelfTokensToken({
  "token": ""
}, context)

Input

  • input object
    • token required string

Output

Output schema unknown

getSelfValidateEmail

clever_cloud.getSelfValidateEmail({}, context)

Input

  • input object
    • validationKey string

Output

Output schema unknown

getSummary

clever_cloud.getSummary(null, context)

Input

This action has no parameters

Output

postUsers

clever_cloud.postUsers({}, context)

Input

  • input object
    • invitationKey string
    • addonBetaInvitationKey string
    • email string
    • pass string
    • url_next string
    • terms string
    • body WannabeUser

Output

Output schema unknown

getUsersId

clever_cloud.getUsersId({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

getUsersIdApplications

clever_cloud.getUsersIdApplications({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

getUsersUserIdGitInfo

clever_cloud.getUsersUserIdGitInfo({
  "userId": ""
}, context)

Input

  • input object
    • userId required string

Output

Output schema unknown

getVendorApps

clever_cloud.getVendorApps({}, context)

Input

  • input object
    • offset integer

Output

getVendorAppsAddonId

clever_cloud.getVendorAppsAddonId({
  "addonId": ""
}, context)

Input

  • input object
    • addonId required string

Output

Output schema unknown

putVendorAppsAddonId

clever_cloud.putVendorAppsAddonId({
  "addonId": ""
}, context)

Input

  • input object
    • addonId required string

Output

Output schema unknown

postVendorBillingOwnerId

clever_cloud.postVendorBillingOwnerId({
  "addonId": "",
  "body": {
    "cost": 0
  }
}, context)

Input

Output

Output schema unknown

Definitions

Addon

  • Addon object: An addon
    • configKeys required array: Environments variables link to the addon.
      • items string
    • creationDate required string: The creation timestamp of the addon
    • id required string: addon_${uuid}
    • name required string
    • plan required Plan
    • provider required Provider
    • realId required string: ${provider}_${uuid2}
    • region required string

AddonProviderSso

  • AddonProviderSso object
    • macaroon required string
    • url required string

AppInstance

  • AppInstance object
    • appId string
    • appPort integer
    • commit string
    • deployNumber integer
    • flavor Flavor
    • id string
    • ip string
    • state string

Application

  • Application object
    • archived required boolean
    • branch required string
    • buildFlavor required Flavor
    • cancelOnPush required boolean
    • commitId required string
    • creationDate required string
    • deployUrl required string
    • deployment required Deployment
    • description required string
    • favourite required boolean
    • homogeneous required boolean
    • id required string
    • instance required Instance
    • last_deploy required integer
    • name required string
    • ownerId required string
    • separateBuild required boolean
    • state required string
    • stickySessions required boolean
    • vhosts required array
    • webhookSecret required string
    • webhookUrl required string
    • zone required string: par ou mtl

Avatar

  • Avatar object: If you want to upload an image from your computer, send the image in the body of the request without anything else.
    • source required object
      • source required string: github or gravatar
      • value required URL

Body

  • Body object
    • body required string

Change Password

Change_Password

  • Change_Password object
    • newPassword required string
    • oldPassword required string

Conso

  • Conso object
    • appId required string
    • conso required object
      • conso required string: One day consumption
      • date required string

Consumer

  • Consumer object
    • baseUrl required string
    • description required string
    • key string
    • name required string
    • picture string
    • rights required ConsumerRights
    • url required string

ConsumerRights

  • ConsumerRights object
    • access_bills boolean
    • access_consumption_statistics boolean
    • access_credit_count boolean
    • access_organisations boolean
    • access_organisations_bills boolean
    • access_organisations_consumption_statistics boolean
    • access_organisations_credit_count boolean
    • access_personal_information boolean
    • almighty boolean
    • manage_applications boolean
    • manage_organisations boolean
    • manage_organisations_applications boolean
    • manage_organisations_members boolean
    • manage_organisations_services boolean
    • manage_personal_information boolean
    • manage_services boolean
    • manage_ssh_keys boolean

Country

  • Country object
    • code required string: Code ISO 3166
    • name required string

Credits

  • Credits object
    • count required number
    • dropPrice required object
      • currency required string
      • value required number
    • ownerId required string

Deployment

  • Deployment object
    • httpUrl string
    • repoState required string
    • shutdownable required boolean
    • type required string
    • url required string

Env

  • Env object
    • addon_id required string
    • addon_name required string
    • env required array
    • provider_id required string

Feature

  • Feature object
    • name required string: The name of the properties
    • type required string: The type of the feature
    • value required string: The value of the feature

Flavor

  • Flavor object
    • available boolean
    • cpus required integer
    • disk integer
    • mem required integer
    • microservice boolean
    • name required string
    • nice number
    • price required number

Instance

  • Instance object
    • buildFlavor Flavor
    • comingSoon boolean
    • defaultEnv required Map
    • defaultFlavor Flavor
    • deployments array
      • items string
    • description string
    • enabled boolean
    • flavors required array
    • instanceAndVersion required string
    • maxAllowedInstances required integer
    • maxFlavor required Flavor
    • maxInstances required integer
    • minFlavor required Flavor
    • minInstances required integer
    • name string
    • tags array
      • items string
    • type required string
    • variant required Variant
    • version required string

Key

  • Key object
    • fingerprint required string
    • key required string
    • name required string

LinkedAppEnv

  • LinkedAppEnv object
    • app_id required string
    • app_name required string
    • env required array

ListEnv

  • ListEnv object
    • name string
    • value string

Map

  • Map object

Member

  • Member object
    • job required string
    • member required object
      • avatar string
      • email required string
      • id required string
      • name string
    • role required string

Organisation

  • Organisation object
    • VAT required string
    • address required string
    • avatar required string
    • city required string
    • company required string
    • country required string
    • description required string
    • id required string
    • name required string
    • vatState required string
    • zipcode required string

Payment Provider

PaymentData

  • PaymentData object
    • deviceData string
    • token required string
    • type required string (values: NEW_CARD, EXISTING_CARD)

Payment_Provider

  • Payment_Provider object
    • comingSoon required boolean
    • imgUrl required string
    • name required string
    • title required string

Plan

  • Plan object
    • features required array: The list of the feature in the addon
    • id required string: plan_${uuid}
    • name required string: Name of the pan
    • price required integer
    • slug required string

Provider

  • Provider object: A provider
    • analyticsId required string: The id of the analytics page link to this addon
    • canUpgrade required boolean: Can the addon be upgraded
    • features array
    • googlePlusName required string: The name of the google + page link to this addon (could be empty)
    • id required string: The id of the provider
    • logoUrl required string: The url of the addon's logo
    • longDesc required string: A less concise description of the addon
    • name required string
    • openInNewTab required boolean: Does the addon panel need to be open in a new tab
    • plans array
    • regions required array: The differents regions where the addon is available
      • items string
    • shortDesc required string: A short description of the addon
    • status required string: The status of this addon (RELEASE, BETA, ...)
    • supportEmail required string: The mail to contact in case of issue with this addon
    • twitterName required string: The name of the user to contact on twitter for this addon (could be empty)
    • website required string: The website of the provider. If the addon is developped by clever-cloud, the site is "http://www.clever-cloud.com/"

Rights

  • Rights object
    • description required string
    • name required string

Secret

  • Secret object
    • secret required string
    • value required string

Sso

  • Sso object
    • email required string
    • id required string
    • nav-data required string
    • timestamp required string
    • token required string
    • url required string

Summary

  • Summary object
    • organisations required array
      • items object
        • addons array
          • items object
            • id string
            • logoUrl string
            • name string
            • providerId string
        • applications array
          • items object
            • archived boolean
            • commit string
            • id string
            • instanceType string
            • instanceVariant string
            • name string
            • state string
            • variantSlug string
        • avatar string
        • consumers array
          • items object
            • key string
            • name string
            • picture string
        • id string
        • name string
        • providers array
          • items string
        • role string
    • user required object
      • addons required array
        • items object
          • id string
          • logoUrl string
          • name string
          • providerId string
      • admin required boolean
      • applications required array
        • items object
          • archived boolean
          • commit string
          • id string
          • instanceType string
          • instanceVariant string
          • name string
          • state string
          • variantSlug string
      • avatar required string
      • consumers array
        • items object
          • key string
          • name string
          • picture string
      • id required string
      • lang required string
      • name required string

Token

  • Token object
    • consumer required Consumer
    • creationDate required integer
    • lastUtilisation required string
    • rights required Rights
    • token required string

Transaction Id

Transaction_Id

  • Transaction_Id object: A simple transaction id
    • transactionId required string: The transaction Id

URL

  • URL object: Must be a valid HTTP URL
    • url required string

User

  • User object: A user representation
    • address required string: The address of the user
    • admin required boolean: Is the user an administrator ?
    • avatar required string: The location of the user's avatar
    • canPay required boolean: Does the user can pay ?
    • city required string: The city of the user
    • country required string: The country of the user
    • creationDate required integer: The creation timestamp of the user
    • email required string: The email of the user
    • emailValidated required boolean: Does the user email is validate
    • hasPassword boolean
    • id required string: The id of the user : user_${uuid}
    • lang required string: The lang of the user
    • name required string: The name of the user
    • oauthApps required array: The list of token oauth
      • items string
    • phone required string: The phone of the user
    • preferredMFA string
    • zipcode required string: The zipcode of the user

Variant

  • Variant object
    • deployType required string
    • id required string
    • logo required string
    • name required string
    • slug required string

Vhost

  • Vhost object
    • fqdn required string

WannabeAddon

  • WannabeAddon object
    • name required string
    • payment required PaymentData
    • plan required string
    • providerId required string
    • region required string

WannabeAddonBilling

  • WannabeAddonBilling object
    • cost required number

WannabeAddonProvider

WannabeAddonProviderAPI

WannabeAddonProviderAPIUrl

  • WannabeAddonProviderAPIUrl object
    • base_url required string
    • sso_url required string

WannabeApplication

  • WannabeApplication object
    • archived boolean
    • cancelOnPush boolean
    • deploy required string
    • description string
    • enabled required boolean
    • favourite boolean
    • homogeneous boolean
    • instanceType string
    • instanceVariant string
    • instanceVersion string
    • maxFlavor string
    • maxInstances required integer
    • minFlavor string
    • minInstances required integer
    • name required string
    • oauthApp WannabeOauthApp
    • oauthAppId string
    • oauthService string
    • separateBuild boolean
    • shutdownable boolean
    • stickySessions boolean
    • tags array
      • items string
    • zone required string

WannabeConsumer

  • WannabeConsumer object
    • baseUrl required URL
    • description string
    • name required string
    • picture string
    • rights required object
      • activated required boolean
      • right required string
    • url required URL

WannabeEnv

  • WannabeEnv object
    • name required string
    • value required string

WannabeFeature

  • WannabeFeature object
    • name required string
    • type required string: BOOLEAN, INTERVAL, FILESIZE, NUMBER, PERCENTAGE

WannabeMember

  • WannabeMember object
    • email required string
    • job string
    • role required string

WannabeOauthApp

  • WannabeOauthApp object
    • name string
    • owner string

WannabeOrganisation

  • WannabeOrganisation object
    • VAT string
    • address string: The address of the organisation.
    • city string: The city of the organisation.
    • company string: The company's name of the organisation.
    • country string: The country of the organisation.
    • description required string: The description of the organisation.
    • name required string: The name of the organisation.
    • zipcode string: The zipcode of the city's organisation.

WannabePlan

  • WannabePlan object
    • features required array
    • name required string
    • price required integer
    • slug required string

WannabePlanFeature

  • WannabePlanFeature object
    • name required string
    • type required string
    • value required string

WannabeUser

  • WannabeUser object
    • address string
    • city string
    • country string
    • email required string
    • lang string
    • name string
    • password required string
    • phone string
    • terms required boolean
    • zipcode string

Zone

  • Zone object
    • correspondingRegion required string
    • internal required boolean
    • name required string

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/clever_cloud

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

2

Version

5.0.0

License

MIT

Unpacked Size

318 kB

Total Files

4

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware