/self/applications

/application/{appId}/environment

• token (query)

/authorize

Handled by our API.

/events/event-socket

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

/github

/github/applications

/notifications/emailhooks/{ownerId}

list created e-mail hooks

• ownerId (path, required) — Automatically added

/notifications/emailhooks/{ownerId}

create a hook for e-mail notifications

• ownerId (path, required) — Automatically added

/notifications/emailhooks/{ownerId}/:id

delete an e-mail hook

• ownerId (path, required) — Automatically added

/notifications/emailhooks/{ownerId}/:id

edit an e-mail hook

• ownerId (path, required) — Automatically added

/notifications/info/events

list available events

/notifications/info/webhookformats

list available webhook formats

/notifications/webhooks/{ownerId}

list created hooks

• ownerId (path, required) — Automatically added

/notifications/webhooks/{ownerId}

create a hook for notifications

• ownerId (path, required) — Automatically added

/notifications/webhooks/{ownerId}/:id

delete a hook

• ownerId (path, required) — Automatically added

/notifications/webhooks/{ownerId}/:id

edit a hook

• ownerId (path, required) — Automatically added

/organisations/{id}/addonproviders/{providerId}

Remove an add-on provider

/organisations/{id}/addonproviders/{providerId}

/organisations/{id}/addonproviders/{providerId}

/organisations/{id}/addonproviders/{providerId}/features

/organisations/{id}/addonproviders/{providerId}/features

/organisations/{id}/addonproviders/{providerId}/features/{featureId}

/organisations/{id}/addonproviders/{providerId}/plans

/organisations/{id}/addonproviders/{providerId}/plans

/organisations/{id}/addonproviders/{providerId}/plans/{planId}

/organisations/{id}/addonproviders/{providerId}/plans/{planId}

/organisations/{id}/addonproviders/{providerId}/plans/{planId}

/organisations/{id}/addonproviders/{providerId}/plans/{planId}/features/{featureName}

/organisations/{id}/addonproviders/{providerId}/plans/{planId}/features/{featureName}

/organisations/{id}/addonproviders/{providerId}/sso

/organisations/{id}/addonproviders/{providerId}/tags

/organisations/{id}/addonproviders/{providerId}/testers

/organisations/{id}/addons

/organisations/{id}/addons

/organisations/{id}/addons/preorders

/organisations/{id}/addons/{addonId}

/organisations/{id}/addons/{addonId}

/organisations/{id}/addons/{addonId}

/organisations/{id}/addons/{addonId}/applications

/organisations/{id}/addons/{addonId}/env

/organisations/{id}/addons/{addonId}/instances

List instances for this add-on.

• deploymentId (query)
• withDeleted (query)

/self/applications

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

/self/applications/{appId}

/self/applications/{appId}

/self/applications/{appId}

/self/applications/{appId}/addons

/self/applications/{appId}/addons

/self/applications/{appId}/addons/env

/self/applications/{appId}/addons/{addonId}

/self/applications/{appId}/branch

/self/applications/{appId}/branches

/self/applications/{appId}/buildflavor

/self/applications/{appId}/dependencies

/self/applications/{appId}/dependencies/env

/self/applications/{appId}/dependencies/{dependencyId}

/self/applications/{appId}/dependencies/{dependencyId}

/self/applications/{appId}/dependents

/self/applications/{appId}/deployments

• limit (query, limit)
• offset (query, offset)
• action (query)

/self/applications/{appId}/deployments/{deploymentId}

/self/applications/{appId}/deployments/{deploymentId}/instances

/self/applications/{appId}/env

/self/applications/{appId}/env

/self/applications/{appId}/env/{envName}

/self/applications/{appId}/env/{envName}

/self/applications/{appId}/exposed_env

/self/applications/{appId}/exposed_env

/self/applications/{appId}/instances

/self/applications/{appId}/instances

/self/applications/{appId}/instances

• commit (query)

/self/applications/{appId}/instances/{instanceId}

/self/applications/{appId}/tags

/self/applications/{appId}/tags/{tag}

/self/applications/{appId}/tags/{tag}

/self/applications/{appId}/vhosts

/self/applications/{appId}/vhosts/favourite

/self/applications/{appId}/vhosts/favourite

/self/applications/{appId}/vhosts/favourite

/self/applications/{appId}/vhosts/{domain}

/self/applications/{appId}/vhosts/{domain}

/self/avatar

/self/change_password

/self/cli_tokens

• cli_token (query)

/self/confirmation_email

/self/consumers

/self/consumers

/self/consumers/{key}

/self/consumers/{key}

/self/consumers/{key}

/self/consumers/{key}/secret

/self/consumptions

• appId (query)
• from (query)
• to (query)

/self/credits

/self/emails

/self/emails/{email}

/self/emails/{email}

/self/id

/self/instances

/self/keys

/self/keys/{key}

/self/keys/{key}

/self/mfa/{kind}

/self/mfa/{kind}

/self/mfa/{kind}

/self/mfa/{kind}/backupcodes

/self/mfa/{kind}/confirmation

/self/payment-info

/self/payments/billings

/self/payments/billings

/self/payments/billings/{bid}

/self/payments/billings/{bid}

/self/payments/billings/{bid}

/self/payments/billings/{bid}.pdf

• token (query)

/self/payments/fullprice/{price}

/self/payments/methods

/self/payments/methods

/self/payments/methods/default

/self/payments/methods/default

/self/payments/methods/{mId}

/self/payments/monthlyinvoice

/self/payments/monthlyinvoice/maxcredit

/self/payments/recurring

/self/payments/recurring

/self/payments/tokens/stripe

/self/tokens

/self/tokens

/self/tokens/{token}

/self/validate_email

• validationKey (query)

/summary

/organisations/{id}/applications/{appId}/deployments

• limit (query, limit)
• offset (query, offset)
• action (query)

/organisations/{id}/applications/{appId}/deployments/{deploymentId}

/organisations/{id}/applications/{appId}/deployments/{deploymentId}/instances

/organisations/{id}/applications/{appId}/env

/organisations/{id}/applications/{appId}/env

/organisations/{id}/applications/{appId}/env/{envName}

/organisations/{id}/applications/{appId}/env/{envName}

/organisations/{id}/applications/{appId}/exposed_env

/organisations/{id}/applications/{appId}/exposed_env

/organisations/{id}/applications/{appId}/instances

/organisations/{id}/applications/{appId}/instances

/organisations/{id}/applications/{appId}/instances

• commit (query)

/organisations/{id}/applications/{appId}/instances/{instanceId}

/organisations/{id}/applications/{appId}/tags

/organisations/{id}/applications/{appId}/tags/{tag}

/organisations/{id}/applications/{appId}/tags/{tag}

/organisations/{id}/applications/{appId}/vhosts

/organisations/{id}/applications/{appId}/vhosts/favourite

/organisations/{id}/applications/{appId}/vhosts/favourite

/organisations/{id}/applications/{appId}/vhosts/favourite

/organisations/{id}/applications/{appId}/vhosts/{domain}

/organisations/{id}/applications/{appId}/vhosts/{domain}

/organisations/{id}/avatar

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

/organisations/{id}/consumers

/organisations/{id}/consumers

/organisations/{id}/consumers/{key}

/organisations/{id}/consumers/{key}

/organisations/{id}/consumers/{key}

/organisations/{id}/consumers/{key}/secret

/organisations/{id}/consumptions

• appId (query)
• from (query)
• to (query)

/organisations/{id}/credits

/organisations/{id}/deployments

/organisations/{id}/instances

/organisations/{id}/members

/organisations/{id}/members

• invitationKey (query)

/organisations/{id}/members/{userId}

/organisations/{id}/members/{userId}

/organisations/{id}/payment-info

/organisations/{id}/payments/billings

/organisations/{id}/payments/billings

/organisations/{id}/payments/billings/unpaid

/organisations/{id}/payments/billings/{bid}

/organisations/{id}/payments/billings/{bid}

/organisations/{id}/payments/billings/{bid}

/organisations/{id}/payments/billings/{bid}.pdf

• token (query)

/organisations/{id}/payments/fullprice/{price}

/organisations/{id}/payments/methods

/organisations/{id}/payments/methods

/organisations/{id}/payments/methods/default

/organisations/{id}/payments/methods/default

/organisations/{id}/payments/methods/{mId}

/organisations/{id}/payments/monthlyinvoice

/organisations/{id}/payments/monthlyinvoice/maxcredit

/organisations/{id}/payments/recurring

/organisations/{id}/payments/recurring

/password_forgotten

/password_forgotten

• login (query)
• drop_tokens (query)
• TesterPass (header)

/password_forgotten/{key}

/password_forgotten/{key}

• pass (query)
• pass2 (query)

/payments/assets/pay_button/{token}/button.png

/payments/coupons/{name}

/payments/providers

/payments/tokens/stripe

/payments/{bid}/end/stripe

/products/addonproviders

/products/addonproviders/{provider_id}

/products/addonproviders/{provider_id}/versions

/products/countries

/products/countrycodes

/products/instances

• for (query)

/products/instances/{type}-{version}

• for (query)
• app (query)

/products/mfa_kinds

/products/packages

• coupon (query)
• orgaId (query)
• currency (query)

/products/prices

/products/zones

/self

/self

/self

/self/addons

Addon

/self/addons

/self/addons/preorders

/self/addons/{addonId}

/self/addons/{addonId}

Specific addon

/self/addons/{addonId}

/self/addons/{addonId}/applications

/self/addons/{addonId}/env

/self/addons/{addonId}/plan

//openapi

/application/{appId}/environment

• token (query)

/github/callback

• code (query)
• state (query)
• error (query)
• error_description (query)
• error_uri (query)
• Cookie (header)

/github/emails

/github/keys

/github/link

/github/link

• transactionId (query) — From GET /github
• redirectUrl (query)

/github/login

• redirectUrl (query)
• fromAuthorize (query)

/github/redeploy

• User-Agent (header)
• X-Github-Event (header)
• X-Hub-Signature (header)

/github/signup

• redirectUrl (query)
• fromAuthorize (query)

/github/signup

• transactionId (query)
• name (query)
• otherId (query)
• otherEmail (query)
• password (query)
• autoLink (query)
• terms (query)

/github/username

/logs-socket/{appId}

WebSocket to get logs for :appID. Optional queryString arg bind_to_es=true to bind WS on log storage and not real time AMQP broker

• appId (path, required) — Automatically added

/logs/drains

Fetch all the logs drains (ccadmin dedicated route)

/logs/drains/{drainId}

Fetch all the logs drains (ccadmin dedicated route)

• drainId (path, required) — Automatically added

/logs/logs-chunked/{appId}

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

• appId (path, required) — Application Id
• download (query) — Tell the user-agent to download the body as a file

/logs/logs-socket/{appId}

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

• appId (path, required) — Application Id
• since (query) — Only fetch logs newer than this (ISO-8601 formatted) date
• filter (query) — A pattern to filter with
• deployment_id (query) — Only fetch logs emitted by this deployment

/logs/{appId}

Fetch the logs for a given application

• appId (path, required) — Application Id
• limit (query, limit) — Number of lines to return
• order (query) — Logs order
• after (query) — Lowest bound for logs date, ISO 8601
• before (query) — Highest bounds for logs date, ISO 8601
• filter (query) — A pattern to filter with
• deployment_id (query) — Only fetch logs emitted by this deployment

/logs/{appId}/drains

Fetch the logs drains for a given application

• appId (path, required) — Automatically added

/logs/{appId}/drains

Add a log drain for a given application

• appId (path, required) — Automatically added

/logs/{appId}/drains/:idOrUrl

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

• appId (path, required) — Automatically added

/logs/{appId}/drains/:idOrUrl

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

• appId (path, required) — Automatically added

/logs/{appId}/sse

Retrieve logs as they come through a sse connection. To have authorization, you have to add `authorization=oAuthAuthorizationString` as query param.

• appId (path, required) — Automatically added

/newsfeeds/blog

/newsfeeds/engineering

/self/addons/{addonId}/sso

/oauth/access_token

• oauth_consumer_key (query)
• oauth_token (query)
• oauth_signature_method (query)
• oauth_signature (query)
• oauth_timestamp (query)
• oauth_nonce (query)
• oauth_version (query)
• oauth_verifier (query)
• oauth_callback (query)
• oauth_token_secret (query)
• oauth_callback_confirmed (query)

/oauth/access_token_query

• oauth_consumer_key (query)
• oauth_token (query)
• oauth_signature_method (query)
• oauth_signature (query)
• oauth_timestamp (query)
• oauth_nonce (query)
• oauth_version (query)
• oauth_verifier (query)
• oauth_callback (query)
• oauth_token_secret (query)
• oauth_callback_confirmed (query)

/oauth/authorize

• oauth_token (query)
• Cookie (header)

/oauth/authorize

• almighty (query)
• access_organisations (query)
• manage_organisations (query)
• manage_organisations_services (query)
• manage_organisations_applications (query)
• manage_organisations_members (query)
• access_organisations_bills (query)
• access_organisations_credit_count (query)
• access_organisations_consumption_statistics (query)
• access_personal_information (query)
• manage_personal_information (query)
• manage_ssh_keys (query)
• manage_services (query)
• manage_applications (query)
• access_bills (query)
• access_credit_count (query)
• access_consumption_statistics (query)
• Cookie (header)

/oauth/request_token

• oauth_consumer_key (query)
• oauth_token (query)
• oauth_signature_method (query)
• oauth_signature (query)
• oauth_timestamp (query)
• oauth_nonce (query)
• oauth_version (query)
• oauth_verifier (query)
• oauth_callback (query)
• oauth_token_secret (query)
• oauth_callback_confirmed (query)

/oauth/request_token_query

• oauth_consumer_key (query)
• oauth_token (query)
• oauth_signature_method (query)
• oauth_signature (query)
• oauth_timestamp (query)
• oauth_nonce (query)
• oauth_version (query)
• oauth_verifier (query)
• oauth_callback (query)
• oauth_token_secret (query)
• oauth_callback_confirmed (query)

/oauth/rights

/openapi.{type}

Get the swagger for this API as {type}

/organisations

• user (query)

/organisations

/organisations/{id}

/organisations/{id}

/organisations/{id}

/organisations/{id}/addonproviders

/organisations/{id}/addonproviders

/self/addons/{addonId}/tags

/organisations/{id}/addons/{addonId}/instances/{instanceId}

Get a specific instance for {addonId}

/organisations/{id}/addons/{addonId}/migrations

Get past migrations from add-on.

/organisations/{id}/addons/{addonId}/migrations

Start a new add-on migration

/organisations/{id}/addons/{addonId}/migrations/{migrationId}

Get a given migration

/organisations/{id}/addons/{addonId}/sso

/organisations/{id}/addons/{addonId}/tags

/organisations/{id}/addons/{addonId}/tags/{tag}

/organisations/{id}/addons/{addonId}/tags/{tag}

/organisations/{id}/applications

/organisations/{id}/applications

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

/organisations/{id}/applications/{appId}

/organisations/{id}/applications/{appId}

/organisations/{id}/applications/{appId}

/organisations/{id}/applications/{appId}/addons

/organisations/{id}/applications/{appId}/addons

/organisations/{id}/applications/{appId}/addons/env

/organisations/{id}/applications/{appId}/addons/{addonId}

/organisations/{id}/applications/{appId}/branch

/organisations/{id}/applications/{appId}/branches

/organisations/{id}/applications/{appId}/buildflavor

/organisations/{id}/applications/{appId}/dependencies

/organisations/{id}/applications/{appId}/dependencies/env

/organisations/{id}/applications/{appId}/dependencies/{dependencyId}

/organisations/{id}/applications/{appId}/dependencies/{dependencyId}

/organisations/{id}/applications/{appId}/dependents

/self/addons/{addonId}/tags/{tag}

/self/addons/{addonId}/tags/{tag}

/users

• invitationKey (query)
• addonBetaInvitationKey (query)
• email (query)
• pass (query)
• url_next (query)
• terms (query)

/users/{id}

/users/{id}/applications

/users/{userId}/git-info

/v2/providers/addon-matomo/resources

Create Matomo addon

/v2/providers/addon-matomo/resources/{matomoId}

Delete Matomo addon

• matomoId (path, required) — Automatically added

/v3/logs/{appId}

Fetch the logs for a given application

• appId (path, required) — Automatically added

/v3/logs/{appId}/drains

Fetch the logs drains for a given application

• appId (path, required) — Automatically added

/v3/logs/{appId}/drains

Add a log drain for a given application

• appId (path, required) — Automatically added

/v3/logs/{appId}/drains/:idOrUrl

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

• appId (path, required) — Automatically added

/v3/logs/{appId}/drains/:idOrUrl

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

• appId (path, required) — Automatically added

/v3/logs/{appId}/logs-chunked

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

• appId (path, required) — Automatically added

/v3/logs/{appId}/logs-socket

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

• appId (path, required) — Automatically added

/v4/addon-providers/addon-matomo/addons/{matomoId}

Get Matomo addon

• matomoId (path, required) — Automatically added

/v4/addon-providers/addon-matomo/token/validate

Validate a keycloak token

• keycloakToken (query) — Environment variable injected on the app with 'KEYCLOAK_TOKEN' name

/v4/addon-providers/config-provider/addons/{configurationProviderId}

Get Addon provider configuration

• configurationProviderId (path, required) — Automatically added

/v4/addon-providers/config-provider/addons/{configurationProviderId}/env

Get provider's addon environment

• configurationProviderId (path, required) — Automatically added

/v4/addon-providers/config-provider/addons/{configurationProviderId}/env

Update provider's addon environment

• configurationProviderId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups

List Network Groups

• ownerId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups

Create Network Group

• ownerId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}

Delete Network Group

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}

Get Network Group

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}/external-peers

Add external peer

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}/external-peers/{peerId}

Remove external peer

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added
• peerId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}/members

List members

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}/members

Add member

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}/members/{memberId}

Remove member

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added
• memberId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}/members/{memberId}

Get member

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added
• memberId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}/peers

List peers

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}/peers/{peerId}

Remove peer

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added
• peerId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}/peers/{peerId}

Get peer

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added
• peerId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}/peers/{peerId}/wireguard/configuration

Get WireGuard® configuration

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added
• peerId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}/peers/{peerId}/wireguard/configuration/stream

Get WireGuard® configuration

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added
• peerId (path, required) — Automatically added

/v4/networkgroups/organisations/{ownerId}/networkgroups/{networkGroupId}/stream

Network Group SSE

• ownerId (path, required) — Automatically added
• networkGroupId (path, required) — Automatically added

/vendor//addons

/vendor//apps/{addonId}/logscollector

/vendor/apps

• offset (query, offset)

/vendor/apps/{addonId}

/vendor/apps/{addonId}

/vendor/apps/{addonId}/consumptions

/vendor/apps/{addonId}/migration_callback

• plan_id (query)
• region (query)