{ "opencollection": "1.0.0", "info": { "name": "OVH OVHcloud API specification Cloud API", "version": "1.0" }, "items": [ { "info": { "name": "Cloud", "type": "folder" }, "items": [ { "info": { "name": "OVH Cloud Get all cloud pending orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/order", "params": [ { "name": "planCode", "value": "", "type": "query", "description": "Order plan code" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get all cloud pending orders" }, { "info": { "name": "OVH Cloud Get product availability", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/order/rule/availability", "params": [ { "name": "addonFamily", "value": "", "type": "query", "description": "Addon family filter" }, { "name": "ovhSubsidiary", "value": "", "type": "query", "description": "OVH subsidiary" }, { "name": "planCode", "value": "", "type": "query", "description": "Plan code filter" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get product availability" }, { "info": { "name": "OVH Cloud Get instance categories", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/order/rule/instanceCategory", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get instance categories" }, { "info": { "name": "OVH Cloud List available services", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project", "params": [ { "name": "iamTags", "value": "", "type": "query", "description": "Filter resources on IAM tags" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available services" }, { "info": { "name": "OVH Cloud Get this object properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get this object properties" }, { "info": { "name": "OVH Cloud Alter this object properties", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Alter this object properties" }, { "info": { "name": "OVH Cloud Activate monthly billing on multiple instances", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/activateMonthlyBilling", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Activate monthly billing on multiple instances" }, { "info": { "name": "OVH Cloud List container registry capabilities per region", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/capabilities/containerRegistry", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List container registry capabilities per region" }, { "info": { "name": "OVH Cloud List of admissionPlugins managed by MKS product that can be enabled or disabled.", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/capabilities/kube/admissionplugins", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List of admissionPlugins managed by MKS product that can be enabled or disabled." }, { "info": { "name": "OVH Cloud List Kubernetes available flavors for a region", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/capabilities/kube/flavors", "params": [ { "name": "region", "value": "", "type": "query", "description": "The region to list available flavors from. Example: GRA11." }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List Kubernetes available flavors for a region" }, { "info": { "name": "OVH Cloud List available log kinds", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/capabilities/kube/log/kind", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available log kinds" }, { "info": { "name": "OVH Cloud Get a log kind", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/capabilities/kube/log/kind/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get a log kind" }, { "info": { "name": "OVH Cloud List Kubernetes regions where cluster creation is possible.", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/capabilities/kube/regions", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List Kubernetes regions where cluster creation is possible." }, { "info": { "name": "OVH Cloud List all available regions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/capabilities/loadbalancer/region", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all available regions" }, { "info": { "name": "OVH Cloud Get specific information of a region", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/capabilities/loadbalancer/region/:regionName", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get specific information of a region" }, { "info": { "name": "OVH Cloud List product availability", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/capabilities/productAvailability", "params": [ { "name": "addonFamily", "value": "", "type": "query", "description": "Addon family filter" }, { "name": "ovhSubsidiary", "value": "", "type": "query", "description": "OVH subsidiary" }, { "name": "planCode", "value": "", "type": "query", "description": "Plan code filter" }, { "name": "planFamily", "value": "", "type": "query", "description": "Plan family filter (deprecated, use addonFamily instead)" }, { "name": "product", "value": "", "type": "query", "description": "Product filter" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List product availability" }, { "info": { "name": "OVH Cloud Confirm service termination", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/confirmTermination", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "The project id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Confirm service termination" }, { "info": { "name": "OVH Cloud List registries of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List registries of the project" }, { "info": { "name": "OVH Cloud Create a new registry", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new registry" }, { "info": { "name": "OVH Cloud Get the registry information", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the registry information" }, { "info": { "name": "OVH Cloud Update the registry", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update the registry" }, { "info": { "name": "OVH Cloud Delete a registry", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a registry" }, { "info": { "name": "OVH Cloud Get available plans for the current registry.", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/capabilities/plan", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get available plans for the current registry." }, { "info": { "name": "OVH Cloud List your IP restrictions applied on Harbor UI and API", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/ipRestrictions/management", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your IP restrictions applied on Harbor UI and API" }, { "info": { "name": "OVH Cloud Replace IP restrictions applied on Harbor UI and API", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/ipRestrictions/management", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Replace IP restrictions applied on Harbor UI and API" }, { "info": { "name": "OVH Cloud List your IP restrictions applied on artifact manager component", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/ipRestrictions/registry", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your IP restrictions applied on artifact manager component" }, { "info": { "name": "OVH Cloud Replace IP restrictions applied on artifact manager component (Docker, Helm, etc...)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/ipRestrictions/registry", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Replace IP restrictions applied on artifact manager component (Docker, Helm, etc...)" }, { "info": { "name": "OVH Cloud Get the registry's OIDC configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/openIdConnect", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the registry's OIDC configuration" }, { "info": { "name": "OVH Cloud Add or replace the registry's OIDC configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/openIdConnect", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add or replace the registry's OIDC configuration" }, { "info": { "name": "OVH Cloud Edit the registry's OIDC configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/openIdConnect", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Edit the registry's OIDC configuration" }, { "info": { "name": "OVH Cloud Delete the registry's OIDC Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/openIdConnect", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete the registry's OIDC Configuration" }, { "info": { "name": "OVH Cloud Show the actual plan of the registry.", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/plan", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Show the actual plan of the registry." }, { "info": { "name": "OVH Cloud Update the plan of a registry.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/plan", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update the plan of a registry." }, { "info": { "name": "OVH Cloud List registry user", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/users", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List registry user" }, { "info": { "name": "OVH Cloud Create a new registry user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/users", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new registry user" }, { "info": { "name": "OVH Cloud Get registry user", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/users/:userID", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userID", "value": "", "type": "path", "description": "UserID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get registry user" }, { "info": { "name": "OVH Cloud Delete a registry user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/users/:userID", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userID", "value": "", "type": "path", "description": "UserID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a registry user" }, { "info": { "name": "OVH Cloud Set the user as Admin", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/containerRegistry/:registryID/users/:userID/setAsAdmin", "params": [ { "name": "registryID", "value": "", "type": "path", "description": "RegistryID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userID", "value": "", "type": "path", "description": "UserID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Set the user as Admin" }, { "info": { "name": "OVH Cloud Get database engines availability", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/availability", "params": [ { "name": "action", "value": "", "type": "query", "description": "Type of action on which restrict the availabilities" }, { "name": "clusterId", "value": "", "type": "query", "description": "Cluster ID on which restrict the availabilities" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "target", "value": "", "type": "query", "description": "Type of target on which restrict the availabilities" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get database engines availability" }, { "info": { "name": "OVH Cloud Get database engines capabilities", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/capabilities", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get database engines capabilities" }, { "info": { "name": "OVH Cloud List all the cassandra clusters of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all the cassandra clusters of the project" }, { "info": { "name": "OVH Cloud Create a new cassandra cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new cassandra cluster" }, { "info": { "name": "OVH Cloud Get cassandra cluster properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get cassandra cluster properties" }, { "info": { "name": "OVH Cloud Update an existing cassandra cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update an existing cassandra cluster" }, { "info": { "name": "OVH Cloud Delete a cassandra cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a cassandra cluster" }, { "info": { "name": "OVH Cloud Get cassandra advanced configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get cassandra advanced configuration" }, { "info": { "name": "OVH Cloud Update cassandra advanced configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update cassandra advanced configuration" }, { "info": { "name": "OVH Cloud List backups of the cassandra", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/backup", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List backups of the cassandra" }, { "info": { "name": "OVH Cloud Get cassandra backups", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/backup/:backupId", "params": [ { "name": "backupId", "value": "", "type": "path", "description": "Backup ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get cassandra backups" }, { "info": { "name": "OVH Cloud Get cassandra advanced configuration fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/capabilities/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get cassandra advanced configuration fields" }, { "info": { "name": "OVH Cloud Get integration capabilities related to the cassandra service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/capabilities/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get integration capabilities related to the cassandra service" }, { "info": { "name": "OVH Cloud Retrieve the certificates of the cassandra cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/certificates", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the certificates of the cassandra cluster" }, { "info": { "name": "OVH Cloud List integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List integrations" }, { "info": { "name": "OVH Cloud Create a new integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new integration" }, { "info": { "name": "OVH Cloud Get an integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get an integration" }, { "info": { "name": "OVH Cloud Delete an integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an integration" }, { "info": { "name": "OVH Cloud List cassandra ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List cassandra ip restrictions" }, { "info": { "name": "OVH Cloud Add ip restrictions to the cassandra", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add ip restrictions to the cassandra" }, { "info": { "name": "OVH Cloud Get cassandra ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get cassandra ip restrictions" }, { "info": { "name": "OVH Cloud Changes the list of ip restrictions to the cassandra", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Changes the list of ip restrictions to the cassandra" }, { "info": { "name": "OVH Cloud Deletes the given IP from the restricted IPs of the cassandra", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Deletes the given IP from the restricted IPs of the cassandra" }, { "info": { "name": "OVH Cloud Retrieve the most recent cassandra log messages (limited to 1000)", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/logs", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the most recent cassandra log messages (limited to 1000)" }, { "info": { "name": "OVH Cloud List maintenances for the cassandra cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/maintenance", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List maintenances for the cassandra cluster" }, { "info": { "name": "OVH Cloud Get the maintenance for the cassandra cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/maintenance/:maintenanceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the maintenance for the cassandra cluster" }, { "info": { "name": "OVH Cloud Apply the maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/maintenance/:maintenanceId/apply", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Apply the maintenance" }, { "info": { "name": "OVH Cloud List available metrics for the cassandra cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/metric", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "extended", "value": "", "type": "query", "description": "Display DB specific metrics" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available metrics for the cassandra cluster" }, { "info": { "name": "OVH Cloud Get the metric values for the cassandra cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/metric/:metricName", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "metricName", "value": "", "type": "path", "description": "Metric name" }, { "name": "period", "value": "", "type": "query", "description": "The period of time to query metrics for" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the metric values for the cassandra cluster" }, { "info": { "name": "OVH Cloud List nodes of the cassandra", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/node", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List nodes of the cassandra" }, { "info": { "name": "OVH Cloud Get cassandra nodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/node/:nodeId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get cassandra nodes" }, { "info": { "name": "OVH Cloud List users of the cassandra", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List users of the cassandra" }, { "info": { "name": "OVH Cloud Create a new user on the cassandra cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new user on the cassandra cluster" }, { "info": { "name": "OVH Cloud Get cassandra users", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get cassandra users" }, { "info": { "name": "OVH Cloud Delete a cassandra user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a cassandra user" }, { "info": { "name": "OVH Cloud Resets the password of a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/cassandra/:clusterId/user/:userId/credentials/reset", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Resets the password of a user" }, { "info": { "name": "OVH Cloud List all the grafana of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all the grafana of the project" }, { "info": { "name": "OVH Cloud Create a new grafana cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new grafana cluster" }, { "info": { "name": "OVH Cloud Get grafana cluster properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get grafana cluster properties" }, { "info": { "name": "OVH Cloud Update an existing grafana cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update an existing grafana cluster" }, { "info": { "name": "OVH Cloud Delete a grafana cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a grafana cluster" }, { "info": { "name": "OVH Cloud Get grafana advanced configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get grafana advanced configuration" }, { "info": { "name": "OVH Cloud Update grafana advanced configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update grafana advanced configuration" }, { "info": { "name": "OVH Cloud List backups of the grafana", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/backup", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List backups of the grafana" }, { "info": { "name": "OVH Cloud Get grafana backups", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/backup/:backupId", "params": [ { "name": "backupId", "value": "", "type": "path", "description": "Backup ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get grafana backups" }, { "info": { "name": "OVH Cloud Get grafana advanced configuration fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/capabilities/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get grafana advanced configuration fields" }, { "info": { "name": "OVH Cloud Get integration capabilities related to the grafana service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/capabilities/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get integration capabilities related to the grafana service" }, { "info": { "name": "OVH Cloud List integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List integrations" }, { "info": { "name": "OVH Cloud Create a new integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new integration" }, { "info": { "name": "OVH Cloud Get an integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get an integration" }, { "info": { "name": "OVH Cloud Delete an integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an integration" }, { "info": { "name": "OVH Cloud List grafana ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List grafana ip restrictions" }, { "info": { "name": "OVH Cloud Add ip restrictions to the grafana", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add ip restrictions to the grafana" }, { "info": { "name": "OVH Cloud Get grafana ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get grafana ip restrictions" }, { "info": { "name": "OVH Cloud Changes the list of ip restrictions to the grafana", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Changes the list of ip restrictions to the grafana" }, { "info": { "name": "OVH Cloud Deletes the given IP from the restricted IPs of the grafana", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Deletes the given IP from the restricted IPs of the grafana" }, { "info": { "name": "OVH Cloud Retrieve the most recent grafana log messages (limited to 1000)", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/logs", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the most recent grafana log messages (limited to 1000)" }, { "info": { "name": "OVH Cloud List maintenances for the grafana cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/maintenance", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List maintenances for the grafana cluster" }, { "info": { "name": "OVH Cloud Get the maintenance for the grafana cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/maintenance/:maintenanceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the maintenance for the grafana cluster" }, { "info": { "name": "OVH Cloud Apply the maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/maintenance/:maintenanceId/apply", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Apply the maintenance" }, { "info": { "name": "OVH Cloud List available metrics for the grafana cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/metric", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "extended", "value": "", "type": "query", "description": "Display DB specific metrics" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available metrics for the grafana cluster" }, { "info": { "name": "OVH Cloud Get the metric values for the grafana cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/metric/:metricName", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "metricName", "value": "", "type": "path", "description": "Metric name" }, { "name": "period", "value": "", "type": "query", "description": "The period of time to query metrics for" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the metric values for the grafana cluster" }, { "info": { "name": "OVH Cloud List nodes of the grafana", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/node", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List nodes of the grafana" }, { "info": { "name": "OVH Cloud Get grafana nodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/node/:nodeId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get grafana nodes" }, { "info": { "name": "OVH Cloud List users of the grafana", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List users of the grafana" }, { "info": { "name": "OVH Cloud Get grafana users", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get grafana users" }, { "info": { "name": "OVH Cloud Resets the password of a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/grafana/:clusterId/user/:userId/credentials/reset", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Resets the password of a user" }, { "info": { "name": "OVH Cloud List all the kafka of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all the kafka of the project" }, { "info": { "name": "OVH Cloud Create a new kafka cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new kafka cluster" }, { "info": { "name": "OVH Cloud Get kafka cluster properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafka cluster properties" }, { "info": { "name": "OVH Cloud Update an existing kafka cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update an existing kafka cluster" }, { "info": { "name": "OVH Cloud Delete a kafka cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a kafka cluster" }, { "info": { "name": "OVH Cloud List acls of the kafka", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/acl", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List acls of the kafka" }, { "info": { "name": "OVH Cloud Create a new acl on the kafka cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/acl", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new acl on the kafka cluster" }, { "info": { "name": "OVH Cloud Get kafka acls", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/acl/:aclId", "params": [ { "name": "aclId", "value": "", "type": "path", "description": "Acl ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafka acls" }, { "info": { "name": "OVH Cloud Delete a kafka acl", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/acl/:aclId", "params": [ { "name": "aclId", "value": "", "type": "path", "description": "Acl ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a kafka acl" }, { "info": { "name": "OVH Cloud Get kafka advanced configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafka advanced configuration" }, { "info": { "name": "OVH Cloud Update kafka advanced configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update kafka advanced configuration" }, { "info": { "name": "OVH Cloud Get kafka advanced configuration fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/capabilities/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafka advanced configuration fields" }, { "info": { "name": "OVH Cloud Get integration capabilities related to the kafka service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/capabilities/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get integration capabilities related to the kafka service" }, { "info": { "name": "OVH Cloud Retrieve the certificates of the kafka cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/certificates", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the certificates of the kafka cluster" }, { "info": { "name": "OVH Cloud List integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List integrations" }, { "info": { "name": "OVH Cloud Create a new integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new integration" }, { "info": { "name": "OVH Cloud Get an integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get an integration" }, { "info": { "name": "OVH Cloud Delete an integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an integration" }, { "info": { "name": "OVH Cloud List kafka ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List kafka ip restrictions" }, { "info": { "name": "OVH Cloud Add ip restrictions to the kafka", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add ip restrictions to the kafka" }, { "info": { "name": "OVH Cloud Get kafka ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafka ip restrictions" }, { "info": { "name": "OVH Cloud Changes the list of ip restrictions to the kafka", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Changes the list of ip restrictions to the kafka" }, { "info": { "name": "OVH Cloud Deletes the given IP from the restricted IPs of the kafka", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Deletes the given IP from the restricted IPs of the kafka" }, { "info": { "name": "OVH Cloud Retrieve the most recent kafka log messages (limited to 1000)", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/logs", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the most recent kafka log messages (limited to 1000)" }, { "info": { "name": "OVH Cloud List maintenances for the kafka cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/maintenance", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List maintenances for the kafka cluster" }, { "info": { "name": "OVH Cloud Get the maintenance for the kafka cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/maintenance/:maintenanceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the maintenance for the kafka cluster" }, { "info": { "name": "OVH Cloud Apply the maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/maintenance/:maintenanceId/apply", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Apply the maintenance" }, { "info": { "name": "OVH Cloud List available metrics for the kafka cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/metric", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "extended", "value": "", "type": "query", "description": "Display DB specific metrics" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available metrics for the kafka cluster" }, { "info": { "name": "OVH Cloud Get the metric values for the kafka cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/metric/:metricName", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "metricName", "value": "", "type": "path", "description": "Metric name" }, { "name": "period", "value": "", "type": "query", "description": "The period of time to query metrics for" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the metric values for the kafka cluster" }, { "info": { "name": "OVH Cloud List nodes of the kafka", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/node", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List nodes of the kafka" }, { "info": { "name": "OVH Cloud Get kafka nodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/node/:nodeId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafka nodes" }, { "info": { "name": "OVH Cloud Retrieve the permissions available on the cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/permissions", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the permissions available on the cluster" }, { "info": { "name": "OVH Cloud List schema registry acls of the kafka", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/schemaRegistryAcl", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List schema registry acls of the kafka" }, { "info": { "name": "OVH Cloud Create a new schema registry acl on the kafka cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/schemaRegistryAcl", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new schema registry acl on the kafka cluster" }, { "info": { "name": "OVH Cloud Get kafka schema registry acls", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/schemaRegistryAcl/:aclId", "params": [ { "name": "aclId", "value": "", "type": "path", "description": "Acl ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafka schema registry acls" }, { "info": { "name": "OVH Cloud Delete a kafka schema registry acl", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/schemaRegistryAcl/:aclId", "params": [ { "name": "aclId", "value": "", "type": "path", "description": "Acl ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a kafka schema registry acl" }, { "info": { "name": "OVH Cloud List topics of the kafka", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/topic", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List topics of the kafka" }, { "info": { "name": "OVH Cloud Create a new topic on the kafka cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/topic", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new topic on the kafka cluster" }, { "info": { "name": "OVH Cloud Get kafka topics", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/topic/:topicId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "topicId", "value": "", "type": "path", "description": "Topic ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafka topics" }, { "info": { "name": "OVH Cloud Updates the topic on the kafka cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/topic/:topicId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "topicId", "value": "", "type": "path", "description": "Topic ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Updates the topic on the kafka cluster" }, { "info": { "name": "OVH Cloud Delete a kafka topic", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/topic/:topicId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "topicId", "value": "", "type": "path", "description": "Topic ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a kafka topic" }, { "info": { "name": "OVH Cloud List topic acls of the kafka", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/topicAcl", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List topic acls of the kafka" }, { "info": { "name": "OVH Cloud Create a new topic acl on the kafka cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/topicAcl", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new topic acl on the kafka cluster" }, { "info": { "name": "OVH Cloud Get kafka topic acls", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/topicAcl/:aclId", "params": [ { "name": "aclId", "value": "", "type": "path", "description": "Acl ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafka topic acls" }, { "info": { "name": "OVH Cloud Delete a kafka topic acl", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/topicAcl/:aclId", "params": [ { "name": "aclId", "value": "", "type": "path", "description": "Acl ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a kafka topic acl" }, { "info": { "name": "OVH Cloud List users of the kafka", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List users of the kafka" }, { "info": { "name": "OVH Cloud Create a new user on the kafka cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new user on the kafka cluster" }, { "info": { "name": "OVH Cloud Get kafka users", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafka users" }, { "info": { "name": "OVH Cloud Delete a kafka user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a kafka user" }, { "info": { "name": "OVH Cloud Retrieve the user acces for the cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/user/:userId/access", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the user acces for the cluster" }, { "info": { "name": "OVH Cloud Resets the password of a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafka/:clusterId/user/:userId/credentials/reset", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Resets the password of a user" }, { "info": { "name": "OVH Cloud List all the kafkaConnect of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all the kafkaConnect of the project" }, { "info": { "name": "OVH Cloud Create a new kafkaConnect cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new kafkaConnect cluster" }, { "info": { "name": "OVH Cloud Get kafkaConnect cluster properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafkaConnect cluster properties" }, { "info": { "name": "OVH Cloud Update an existing kafkaConnect cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update an existing kafkaConnect cluster" }, { "info": { "name": "OVH Cloud Delete a kafkaConnect cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a kafkaConnect cluster" }, { "info": { "name": "OVH Cloud Get kafkaConnect advanced configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafkaConnect advanced configuration" }, { "info": { "name": "OVH Cloud Update kafkaConnect advanced configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update kafkaConnect advanced configuration" }, { "info": { "name": "OVH Cloud Get kafkaConnect advanced configuration fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/capabilities/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafkaConnect advanced configuration fields" }, { "info": { "name": "OVH Cloud List Kafka Connect connectors", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/capabilities/connector", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List Kafka Connect connectors" }, { "info": { "name": "OVH Cloud Get Kafka Connect connector capability", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/capabilities/connector/:connectorId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectorId", "value": "", "type": "path", "description": "Connector ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get Kafka Connect connector capability" }, { "info": { "name": "OVH Cloud Get Kafka Connect connector configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/capabilities/connector/:connectorId/configuration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectorId", "value": "", "type": "path", "description": "Connector ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get Kafka Connect connector configuration" }, { "info": { "name": "OVH Cloud Get Kafka Connect connector transforms", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/capabilities/connector/:connectorId/transforms", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectorId", "value": "", "type": "path", "description": "Connector ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get Kafka Connect connector transforms" }, { "info": { "name": "OVH Cloud Get integration capabilities related to the kafkaConnect service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/capabilities/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get integration capabilities related to the kafkaConnect service" }, { "info": { "name": "OVH Cloud List the connectors", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/connector", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List the connectors" }, { "info": { "name": "OVH Cloud Create a new connector", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/connector", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new connector" }, { "info": { "name": "OVH Cloud Get connector", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/connector/:connectorId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectorId", "value": "", "type": "path", "description": "Connector ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get connector" }, { "info": { "name": "OVH Cloud Update a connector", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/connector/:connectorId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectorId", "value": "", "type": "path", "description": "Connector ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update a connector" }, { "info": { "name": "OVH Cloud Delete a connector", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/connector/:connectorId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectorId", "value": "", "type": "path", "description": "Connector ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a connector" }, { "info": { "name": "OVH Cloud Pause the kafka connector execution", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/connector/:connectorId/pause", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectorId", "value": "", "type": "path", "description": "Connector ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Pause the kafka connector execution" }, { "info": { "name": "OVH Cloud Restart the kafka connector execution", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/connector/:connectorId/restart", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectorId", "value": "", "type": "path", "description": "Connector ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Restart the kafka connector execution" }, { "info": { "name": "OVH Cloud Resume the kafka connector execution", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/connector/:connectorId/resume", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectorId", "value": "", "type": "path", "description": "Connector ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Resume the kafka connector execution" }, { "info": { "name": "OVH Cloud List the connector tasks", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/connector/:connectorId/task", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectorId", "value": "", "type": "path", "description": "Connector ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List the connector tasks" }, { "info": { "name": "OVH Cloud Get connector task", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/connector/:connectorId/task/:taskId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectorId", "value": "", "type": "path", "description": "Connector ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "taskId", "value": "", "type": "path", "description": "Task ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get connector task" }, { "info": { "name": "OVH Cloud Restart the kafka connector task execution", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/connector/:connectorId/task/:taskId/restart", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectorId", "value": "", "type": "path", "description": "Connector ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "taskId", "value": "", "type": "path", "description": "Task ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Restart the kafka connector task execution" }, { "info": { "name": "OVH Cloud List integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List integrations" }, { "info": { "name": "OVH Cloud Create a new integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new integration" }, { "info": { "name": "OVH Cloud Get an integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get an integration" }, { "info": { "name": "OVH Cloud Delete an integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an integration" }, { "info": { "name": "OVH Cloud List kafkaConnect ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List kafkaConnect ip restrictions" }, { "info": { "name": "OVH Cloud Add ip restrictions to the kafkaConnect", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add ip restrictions to the kafkaConnect" }, { "info": { "name": "OVH Cloud Get kafkaConnect ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafkaConnect ip restrictions" }, { "info": { "name": "OVH Cloud Changes the list of ip restrictions to the kafkaConnect", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Changes the list of ip restrictions to the kafkaConnect" }, { "info": { "name": "OVH Cloud Deletes the given IP from the restricted IPs of the kafkaConnect", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Deletes the given IP from the restricted IPs of the kafkaConnect" }, { "info": { "name": "OVH Cloud Retrieve the most recent kafkaConnect log messages (limited to 1000)", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/logs", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the most recent kafkaConnect log messages (limited to 1000)" }, { "info": { "name": "OVH Cloud List maintenances for the kafka connect cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/maintenance", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List maintenances for the kafka connect cluster" }, { "info": { "name": "OVH Cloud Get the maintenance for the kafka connect cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/maintenance/:maintenanceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the maintenance for the kafka connect cluster" }, { "info": { "name": "OVH Cloud Apply the maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/maintenance/:maintenanceId/apply", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Apply the maintenance" }, { "info": { "name": "OVH Cloud List available metrics for the kafkaConnect cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/metric", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "extended", "value": "", "type": "query", "description": "Display DB specific metrics" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available metrics for the kafkaConnect cluster" }, { "info": { "name": "OVH Cloud Get the metric values for the kafkaConnect cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/metric/:metricName", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "metricName", "value": "", "type": "path", "description": "Metric name" }, { "name": "period", "value": "", "type": "query", "description": "The period of time to query metrics for" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the metric values for the kafkaConnect cluster" }, { "info": { "name": "OVH Cloud List nodes of the kafkaConnect", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/node", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List nodes of the kafkaConnect" }, { "info": { "name": "OVH Cloud Get kafkaConnect nodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/node/:nodeId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafkaConnect nodes" }, { "info": { "name": "OVH Cloud List users of the kafkaConnect", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List users of the kafkaConnect" }, { "info": { "name": "OVH Cloud Create a new user on the kafkaConnect cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new user on the kafkaConnect cluster" }, { "info": { "name": "OVH Cloud Get kafkaConnect users", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafkaConnect users" }, { "info": { "name": "OVH Cloud Delete a kafkaConnect user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a kafkaConnect user" }, { "info": { "name": "OVH Cloud Resets the password of a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaConnect/:clusterId/user/:userId/credentials/reset", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Resets the password of a user" }, { "info": { "name": "OVH Cloud List all the kafkaMirrorMaker of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all the kafkaMirrorMaker of the project" }, { "info": { "name": "OVH Cloud Create a new kafkaMirrorMaker", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new kafkaMirrorMaker" }, { "info": { "name": "OVH Cloud Get kafkaMirrorMaker properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafkaMirrorMaker properties" }, { "info": { "name": "OVH Cloud Update an existing kafkaMirrorMaker", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update an existing kafkaMirrorMaker" }, { "info": { "name": "OVH Cloud Delete a kafkaMirrorMaker", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a kafkaMirrorMaker" }, { "info": { "name": "OVH Cloud Get integration capabilities related to the kafkaMirrorMaker service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/capabilities/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get integration capabilities related to the kafkaMirrorMaker service" }, { "info": { "name": "OVH Cloud List integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List integrations" }, { "info": { "name": "OVH Cloud Create a new integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new integration" }, { "info": { "name": "OVH Cloud Get an integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get an integration" }, { "info": { "name": "OVH Cloud Delete an integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an integration" }, { "info": { "name": "OVH Cloud Retrieve the most recent kafkaMirrorMaker log messages (limited to 1000)", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/logs", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the most recent kafkaMirrorMaker log messages (limited to 1000)" }, { "info": { "name": "OVH Cloud List maintenances for the kafka mirror maker cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/maintenance", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List maintenances for the kafka mirror maker cluster" }, { "info": { "name": "OVH Cloud Get the maintenance for the kafka mirror maker cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/maintenance/:maintenanceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the maintenance for the kafka mirror maker cluster" }, { "info": { "name": "OVH Cloud Apply the maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/maintenance/:maintenanceId/apply", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Apply the maintenance" }, { "info": { "name": "OVH Cloud List available metrics for the kafkaMirrorMaker", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/metric", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "extended", "value": "", "type": "query", "description": "Display DB specific metrics" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available metrics for the kafkaMirrorMaker" }, { "info": { "name": "OVH Cloud Get the metric values for the kafkaMirrorMaker", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/metric/:metricName", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "metricName", "value": "", "type": "path", "description": "Metric name" }, { "name": "period", "value": "", "type": "query", "description": "The period of time to query metrics for" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the metric values for the kafkaMirrorMaker" }, { "info": { "name": "OVH Cloud List nodes of the kafkaMirrorMaker", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/node", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List nodes of the kafkaMirrorMaker" }, { "info": { "name": "OVH Cloud Get kafkaMirrorMaker nodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/node/:nodeId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafkaMirrorMaker nodes" }, { "info": { "name": "OVH Cloud List replication of the kafkaMirrorMaker", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/replication", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List replication of the kafkaMirrorMaker" }, { "info": { "name": "OVH Cloud Create a new replication", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/replication", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new replication" }, { "info": { "name": "OVH Cloud Get kafkaMirrorMaker replication", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/replication/:replicationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "replicationId", "value": "", "type": "path", "description": "Replication ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get kafkaMirrorMaker replication" }, { "info": { "name": "OVH Cloud Updates a replication", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/replication/:replicationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "replicationId", "value": "", "type": "path", "description": "Replication ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Updates a replication" }, { "info": { "name": "OVH Cloud Delete an replication", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/kafkaMirrorMaker/:clusterId/replication/:replicationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "replicationId", "value": "", "type": "path", "description": "Replication ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an replication" }, { "info": { "name": "OVH Cloud List all the m3aggregator of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all the m3aggregator of the project" }, { "info": { "name": "OVH Cloud Create a new m3aggregator", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new m3aggregator" }, { "info": { "name": "OVH Cloud Get m3aggregator properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get m3aggregator properties" }, { "info": { "name": "OVH Cloud Update an existing m3aggregator", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update an existing m3aggregator" }, { "info": { "name": "OVH Cloud Delete a m3aggregator", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a m3aggregator" }, { "info": { "name": "OVH Cloud Get integration capabilities related to the m3aggregator service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/capabilities/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get integration capabilities related to the m3aggregator service" }, { "info": { "name": "OVH Cloud List integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List integrations" }, { "info": { "name": "OVH Cloud Create a new integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new integration" }, { "info": { "name": "OVH Cloud Get an integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get an integration" }, { "info": { "name": "OVH Cloud Delete an integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an integration" }, { "info": { "name": "OVH Cloud Retrieve the most recent m3aggregator log messages (limited to 1000)", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/logs", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the most recent m3aggregator log messages (limited to 1000)" }, { "info": { "name": "OVH Cloud List maintenances for the m3aggregator cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/maintenance", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List maintenances for the m3aggregator cluster" }, { "info": { "name": "OVH Cloud Get the maintenance for the m3aggregator cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/maintenance/:maintenanceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the maintenance for the m3aggregator cluster" }, { "info": { "name": "OVH Cloud Apply the maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/maintenance/:maintenanceId/apply", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Apply the maintenance" }, { "info": { "name": "OVH Cloud List available metrics for the m3aggregator", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/metric", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "extended", "value": "", "type": "query", "description": "Display DB specific metrics" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available metrics for the m3aggregator" }, { "info": { "name": "OVH Cloud Get the metric values for the m3aggregator", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/metric/:metricName", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "metricName", "value": "", "type": "path", "description": "Metric name" }, { "name": "period", "value": "", "type": "query", "description": "The period of time to query metrics for" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the metric values for the m3aggregator" }, { "info": { "name": "OVH Cloud List nodes of the m3aggregator", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/node", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List nodes of the m3aggregator" }, { "info": { "name": "OVH Cloud Get m3aggregator nodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3aggregator/:clusterId/node/:nodeId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get m3aggregator nodes" }, { "info": { "name": "OVH Cloud List all the m3db clusters of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all the m3db clusters of the project" }, { "info": { "name": "OVH Cloud Create a new m3db cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new m3db cluster" }, { "info": { "name": "OVH Cloud Get m3db cluster properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get m3db cluster properties" }, { "info": { "name": "OVH Cloud Update an existing m3db cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update an existing m3db cluster" }, { "info": { "name": "OVH Cloud Delete a m3db cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a m3db cluster" }, { "info": { "name": "OVH Cloud Get m3db advanced configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get m3db advanced configuration" }, { "info": { "name": "OVH Cloud Update m3db advanced configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update m3db advanced configuration" }, { "info": { "name": "OVH Cloud List backups of the m3db", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/backup", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List backups of the m3db" }, { "info": { "name": "OVH Cloud Get m3db backups", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/backup/:backupId", "params": [ { "name": "backupId", "value": "", "type": "path", "description": "Backup ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get m3db backups" }, { "info": { "name": "OVH Cloud Get m3db advanced configuration fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/capabilities/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get m3db advanced configuration fields" }, { "info": { "name": "OVH Cloud Get integration capabilities related to the m3db service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/capabilities/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get integration capabilities related to the m3db service" }, { "info": { "name": "OVH Cloud List integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List integrations" }, { "info": { "name": "OVH Cloud Create a new integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new integration" }, { "info": { "name": "OVH Cloud Get an integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get an integration" }, { "info": { "name": "OVH Cloud Delete an integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an integration" }, { "info": { "name": "OVH Cloud List m3db ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List m3db ip restrictions" }, { "info": { "name": "OVH Cloud Add ip restrictions to the m3db", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add ip restrictions to the m3db" }, { "info": { "name": "OVH Cloud Get m3db ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get m3db ip restrictions" }, { "info": { "name": "OVH Cloud Changes the list of ip restrictions to the m3db", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Changes the list of ip restrictions to the m3db" }, { "info": { "name": "OVH Cloud Deletes the given IP from the restricted IPs of the m3db", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Deletes the given IP from the restricted IPs of the m3db" }, { "info": { "name": "OVH Cloud Retrieve the most recent m3db log messages (limited to 1000)", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/logs", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the most recent m3db log messages (limited to 1000)" }, { "info": { "name": "OVH Cloud List maintenances for the m3db cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/maintenance", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List maintenances for the m3db cluster" }, { "info": { "name": "OVH Cloud Get the maintenance for the m3db cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/maintenance/:maintenanceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the maintenance for the m3db cluster" }, { "info": { "name": "OVH Cloud Apply the maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/maintenance/:maintenanceId/apply", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Apply the maintenance" }, { "info": { "name": "OVH Cloud List available metrics for the m3db cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/metric", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "extended", "value": "", "type": "query", "description": "Display DB specific metrics" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available metrics for the m3db cluster" }, { "info": { "name": "OVH Cloud Get the metric values for the m3db cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/metric/:metricName", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "metricName", "value": "", "type": "path", "description": "Metric name" }, { "name": "period", "value": "", "type": "query", "description": "The period of time to query metrics for" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the metric values for the m3db cluster" }, { "info": { "name": "OVH Cloud List namespaces of the m3db", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/namespace", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List namespaces of the m3db" }, { "info": { "name": "OVH Cloud Create a new namespace on the m3db cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/namespace", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new namespace on the m3db cluster" }, { "info": { "name": "OVH Cloud Get m3db namespaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/namespace/:namespaceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "namespaceId", "value": "", "type": "path", "description": "Namespace ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get m3db namespaces" }, { "info": { "name": "OVH Cloud Updates the namespace on the m3db cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/namespace/:namespaceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "namespaceId", "value": "", "type": "path", "description": "Namespace ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Updates the namespace on the m3db cluster" }, { "info": { "name": "OVH Cloud Delete m3db namespace", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/namespace/:namespaceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "namespaceId", "value": "", "type": "path", "description": "Namespace ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete m3db namespace" }, { "info": { "name": "OVH Cloud List nodes of the m3db", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/node", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List nodes of the m3db" }, { "info": { "name": "OVH Cloud Get m3db nodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/node/:nodeId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get m3db nodes" }, { "info": { "name": "OVH Cloud List users of the m3db", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List users of the m3db" }, { "info": { "name": "OVH Cloud Create a new user on the m3db cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new user on the m3db cluster" }, { "info": { "name": "OVH Cloud Get m3db users", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get m3db users" }, { "info": { "name": "OVH Cloud Updates the user on the m3db cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Updates the user on the m3db cluster" }, { "info": { "name": "OVH Cloud Delete m3db user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete m3db user" }, { "info": { "name": "OVH Cloud Resets the password of a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/m3db/:clusterId/user/:userId/credentials/reset", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Resets the password of a user" }, { "info": { "name": "OVH Cloud List all the mysql of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all the mysql of the project" }, { "info": { "name": "OVH Cloud Create a new mysql cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new mysql cluster" }, { "info": { "name": "OVH Cloud Get mysql cluster properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get mysql cluster properties" }, { "info": { "name": "OVH Cloud Update an existing mysql cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update an existing mysql cluster" }, { "info": { "name": "OVH Cloud Delete a mysql cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a mysql cluster" }, { "info": { "name": "OVH Cloud Get mysql advanced configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get mysql advanced configuration" }, { "info": { "name": "OVH Cloud Update mysql advanced configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update mysql advanced configuration" }, { "info": { "name": "OVH Cloud List backups of the mysql", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/backup", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List backups of the mysql" }, { "info": { "name": "OVH Cloud Get mysql backups", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/backup/:backupId", "params": [ { "name": "backupId", "value": "", "type": "path", "description": "Backup ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get mysql backups" }, { "info": { "name": "OVH Cloud Get mysql advanced configuration fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/capabilities/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get mysql advanced configuration fields" }, { "info": { "name": "OVH Cloud Get integration capabilities related to the mysql service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/capabilities/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get integration capabilities related to the mysql service" }, { "info": { "name": "OVH Cloud Retrieve the certificates of the mysql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/certificates", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the certificates of the mysql cluster" }, { "info": { "name": "OVH Cloud Retrieve the current queries for the cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/currentQueries", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "limit", "value": "", "type": "query", "description": "Limit size of the result set returned by the pagination" }, { "name": "offset", "value": "", "type": "query", "description": "Offset of the result set returned by the pagination" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the current queries for the cluster" }, { "info": { "name": "OVH Cloud Cancel the given current query of the cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/currentQueries/cancel", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Cancel the given current query of the cluster" }, { "info": { "name": "GET /cloud/project/{serviceName}/database/mysql/{clusterId}/database", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/database", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "OVH Cloud Create a new database on the mysql cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/database", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new database on the mysql cluster" }, { "info": { "name": "OVH Cloud Get the database for the mysql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/database/:databaseId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "databaseId", "value": "", "type": "path", "description": "Database ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the database for the mysql cluster" }, { "info": { "name": "OVH Cloud Delete a mysql database", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/database/:databaseId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "databaseId", "value": "", "type": "path", "description": "Database ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a mysql database" }, { "info": { "name": "OVH Cloud Enable temporary write permission on readonly lock mysql service", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/enableWrites", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Enable temporary write permission on readonly lock mysql service" }, { "info": { "name": "OVH Cloud List integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List integrations" }, { "info": { "name": "OVH Cloud Create a new integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new integration" }, { "info": { "name": "OVH Cloud Get an integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get an integration" }, { "info": { "name": "OVH Cloud Delete an integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an integration" }, { "info": { "name": "OVH Cloud List mysql ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List mysql ip restrictions" }, { "info": { "name": "OVH Cloud Add ip restrictions to the mysql", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add ip restrictions to the mysql" }, { "info": { "name": "OVH Cloud Get mysql ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get mysql ip restrictions" }, { "info": { "name": "OVH Cloud Changes the list of ip restrictions to the mysql", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Changes the list of ip restrictions to the mysql" }, { "info": { "name": "OVH Cloud Deletes the given IP from the restricted IPs of the mysql", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Deletes the given IP from the restricted IPs of the mysql" }, { "info": { "name": "OVH Cloud Retrieve the most recent mysql log messages (limited to 1000)", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/logs", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the most recent mysql log messages (limited to 1000)" }, { "info": { "name": "OVH Cloud List maintenances for the mysql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/maintenance", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List maintenances for the mysql cluster" }, { "info": { "name": "OVH Cloud Get the maintenance for the mysql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/maintenance/:maintenanceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the maintenance for the mysql cluster" }, { "info": { "name": "OVH Cloud Apply the maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/maintenance/:maintenanceId/apply", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Apply the maintenance" }, { "info": { "name": "OVH Cloud List available metrics for the mysql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/metric", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "extended", "value": "", "type": "query", "description": "Display DB specific metrics" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available metrics for the mysql cluster" }, { "info": { "name": "OVH Cloud Get the metric values for the mysql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/metric/:metricName", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "metricName", "value": "", "type": "path", "description": "Metric name" }, { "name": "period", "value": "", "type": "query", "description": "The period of time to query metrics for" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the metric values for the mysql cluster" }, { "info": { "name": "OVH Cloud List nodes of the mysql", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/node", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List nodes of the mysql" }, { "info": { "name": "OVH Cloud Get mysql nodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/node/:nodeId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get mysql nodes" }, { "info": { "name": "OVH Cloud Retrieve the query statistics for the cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/queryStatistics", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "limit", "value": "", "type": "query", "description": "Limit size of the result set returned by the pagination" }, { "name": "offset", "value": "", "type": "query", "description": "Offset of the result set returned by the pagination" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the query statistics for the cluster" }, { "info": { "name": "OVH Cloud Reset the query statistics of the cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/queryStatistics/reset", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Reset the query statistics of the cluster" }, { "info": { "name": "OVH Cloud List users of the mysql", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List users of the mysql" }, { "info": { "name": "OVH Cloud Create a new user on the mysql cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new user on the mysql cluster" }, { "info": { "name": "OVH Cloud Get mysql users", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get mysql users" }, { "info": { "name": "OVH Cloud Delete a mysql user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a mysql user" }, { "info": { "name": "OVH Cloud Resets the password of a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/mysql/:clusterId/user/:userId/credentials/reset", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Resets the password of a user" }, { "info": { "name": "OVH Cloud List all the opensearch of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all the opensearch of the project" }, { "info": { "name": "OVH Cloud Create a new opensearch cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new opensearch cluster" }, { "info": { "name": "OVH Cloud Get opensearch cluster properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get opensearch cluster properties" }, { "info": { "name": "OVH Cloud Update an existing opensearch cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update an existing opensearch cluster" }, { "info": { "name": "OVH Cloud Delete a opensearch cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a opensearch cluster" }, { "info": { "name": "OVH Cloud Get opensearch advanced configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get opensearch advanced configuration" }, { "info": { "name": "OVH Cloud Update opensearch advanced configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update opensearch advanced configuration" }, { "info": { "name": "OVH Cloud List backups of the opensearch", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/backup", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List backups of the opensearch" }, { "info": { "name": "OVH Cloud Get opensearch backups", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/backup/:backupId", "params": [ { "name": "backupId", "value": "", "type": "path", "description": "Backup ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get opensearch backups" }, { "info": { "name": "OVH Cloud Get opensearch advanced configuration fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/capabilities/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get opensearch advanced configuration fields" }, { "info": { "name": "OVH Cloud Get integration capabilities related to the opensearch service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/capabilities/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get integration capabilities related to the opensearch service" }, { "info": { "name": "OVH Cloud List indexes of the opensearch", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/index", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List indexes of the opensearch" }, { "info": { "name": "OVH Cloud Get opensearch index", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/index/:indexId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "indexId", "value": "", "type": "path", "description": "Index ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get opensearch index" }, { "info": { "name": "OVH Cloud Delete an opensearch index", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/index/:indexId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "indexId", "value": "", "type": "path", "description": "Index ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an opensearch index" }, { "info": { "name": "OVH Cloud List integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List integrations" }, { "info": { "name": "OVH Cloud Create a new integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new integration" }, { "info": { "name": "OVH Cloud Get an integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get an integration" }, { "info": { "name": "OVH Cloud Delete an integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an integration" }, { "info": { "name": "OVH Cloud List opensearch ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List opensearch ip restrictions" }, { "info": { "name": "OVH Cloud Add ip restrictions to the opensearch", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add ip restrictions to the opensearch" }, { "info": { "name": "OVH Cloud Get opensearch ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get opensearch ip restrictions" }, { "info": { "name": "OVH Cloud Changes the list of ip restrictions to the opensearch", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Changes the list of ip restrictions to the opensearch" }, { "info": { "name": "OVH Cloud Deletes the given IP from the restricted IPs of the opensearch", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Deletes the given IP from the restricted IPs of the opensearch" }, { "info": { "name": "OVH Cloud Retrieve the most recent opensearch log messages (limited to 1000)", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/logs", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the most recent opensearch log messages (limited to 1000)" }, { "info": { "name": "OVH Cloud List maintenances for the opensearch cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/maintenance", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List maintenances for the opensearch cluster" }, { "info": { "name": "OVH Cloud Get the maintenance for the opensearch cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/maintenance/:maintenanceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the maintenance for the opensearch cluster" }, { "info": { "name": "OVH Cloud Apply the maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/maintenance/:maintenanceId/apply", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Apply the maintenance" }, { "info": { "name": "OVH Cloud List available metrics for the opensearch cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/metric", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "extended", "value": "", "type": "query", "description": "Display DB specific metrics" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available metrics for the opensearch cluster" }, { "info": { "name": "OVH Cloud Get the metric values for the opensearch cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/metric/:metricName", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "metricName", "value": "", "type": "path", "description": "Metric name" }, { "name": "period", "value": "", "type": "query", "description": "The period of time to query metrics for" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the metric values for the opensearch cluster" }, { "info": { "name": "OVH Cloud List nodes of the opensearch", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/node", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List nodes of the opensearch" }, { "info": { "name": "OVH Cloud Get opensearch nodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/node/:nodeId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get opensearch nodes" }, { "info": { "name": "OVH Cloud List patterns of the opensearch", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/pattern", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List patterns of the opensearch" }, { "info": { "name": "OVH Cloud Create a new pattern on the opensearch cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/pattern", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new pattern on the opensearch cluster" }, { "info": { "name": "OVH Cloud Get opensearch patterns", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/pattern/:patternId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "patternId", "value": "", "type": "path", "description": "Pattern ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get opensearch patterns" }, { "info": { "name": "OVH Cloud Delete an opensearch pattern", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/pattern/:patternId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "patternId", "value": "", "type": "path", "description": "Pattern ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an opensearch pattern" }, { "info": { "name": "OVH Cloud Retrieve the opensearch permissions values", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/permissions", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the opensearch permissions values" }, { "info": { "name": "OVH Cloud List users of the opensearch", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List users of the opensearch" }, { "info": { "name": "OVH Cloud Create a new user on the opensearch cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new user on the opensearch cluster" }, { "info": { "name": "OVH Cloud Get opensearch users", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get opensearch users" }, { "info": { "name": "OVH Cloud Update a user on the opensearch cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update a user on the opensearch cluster" }, { "info": { "name": "OVH Cloud Delete a opensearch user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a opensearch user" }, { "info": { "name": "OVH Cloud Resets the password of a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/opensearch/:clusterId/user/:userId/credentials/reset", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Resets the password of a user" }, { "info": { "name": "OVH Cloud List all the postgresql of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all the postgresql of the project" }, { "info": { "name": "OVH Cloud Create a new postgresql cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new postgresql cluster" }, { "info": { "name": "OVH Cloud Get postgresql cluster properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get postgresql cluster properties" }, { "info": { "name": "OVH Cloud Update an existing postgresql cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update an existing postgresql cluster" }, { "info": { "name": "OVH Cloud Delete a postgresql cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a postgresql cluster" }, { "info": { "name": "OVH Cloud Get postgresql advanced configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get postgresql advanced configuration" }, { "info": { "name": "OVH Cloud Update postgresql advanced configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update postgresql advanced configuration" }, { "info": { "name": "OVH Cloud List backups of the postgresql", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/backup", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List backups of the postgresql" }, { "info": { "name": "OVH Cloud Get postgresql backups", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/backup/:backupId", "params": [ { "name": "backupId", "value": "", "type": "path", "description": "Backup ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get postgresql backups" }, { "info": { "name": "OVH Cloud Get postgresql advanced configuration fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/capabilities/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get postgresql advanced configuration fields" }, { "info": { "name": "OVH Cloud Get integration capabilities related to the postgresql service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/capabilities/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get integration capabilities related to the postgresql service" }, { "info": { "name": "OVH Cloud Retrieve the certificates of the postgresql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/certificates", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the certificates of the postgresql cluster" }, { "info": { "name": "GET /cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/connectionPool", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "OVH Cloud Create a new connectionPool on the postgresql cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/connectionPool", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new connectionPool on the postgresql cluster" }, { "info": { "name": "OVH Cloud Get the connectionPool for the postgresql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/connectionPool/:connectionPoolId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectionPoolId", "value": "", "type": "path", "description": "Connection pool ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the connectionPool for the postgresql cluster" }, { "info": { "name": "OVH Cloud Update a connectionPool on the postgresql cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/connectionPool/:connectionPoolId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectionPoolId", "value": "", "type": "path", "description": "Connection pool ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update a connectionPool on the postgresql cluster" }, { "info": { "name": "OVH Cloud Delete a postgresql connectionPool", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/connectionPool/:connectionPoolId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "connectionPoolId", "value": "", "type": "path", "description": "Connection pool ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a postgresql connectionPool" }, { "info": { "name": "OVH Cloud Retrieve the current queries for the cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/currentQueries", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "limit", "value": "", "type": "query", "description": "Limit size of the result set returned by the pagination" }, { "name": "offset", "value": "", "type": "query", "description": "Offset of the result set returned by the pagination" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the current queries for the cluster" }, { "info": { "name": "OVH Cloud Cancel the given current query of the cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/currentQueries/cancel", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Cancel the given current query of the cluster" }, { "info": { "name": "GET /cloud/project/{serviceName}/database/postgresql/{clusterId}/database", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/database", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "OVH Cloud Create a new database on the postgresql cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/database", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new database on the postgresql cluster" }, { "info": { "name": "OVH Cloud Get the database for the postgresql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/database/:databaseId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "databaseId", "value": "", "type": "path", "description": "Database ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the database for the postgresql cluster" }, { "info": { "name": "OVH Cloud Delete a postgresql database", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/database/:databaseId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "databaseId", "value": "", "type": "path", "description": "Database ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a postgresql database" }, { "info": { "name": "OVH Cloud Enable temporary write permission on readonly lock postgresql service", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/enableWrites", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Enable temporary write permission on readonly lock postgresql service" }, { "info": { "name": "OVH Cloud List integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List integrations" }, { "info": { "name": "OVH Cloud Create a new integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new integration" }, { "info": { "name": "OVH Cloud Get an integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get an integration" }, { "info": { "name": "OVH Cloud Delete an integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an integration" }, { "info": { "name": "OVH Cloud List postgresql ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List postgresql ip restrictions" }, { "info": { "name": "OVH Cloud Add ip restrictions to the postgresql", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add ip restrictions to the postgresql" }, { "info": { "name": "OVH Cloud Get postgresql ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get postgresql ip restrictions" }, { "info": { "name": "OVH Cloud Changes the list of ip restrictions to the postgresql", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Changes the list of ip restrictions to the postgresql" }, { "info": { "name": "OVH Cloud Deletes the given IP from the restricted IPs of the postgresql", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Deletes the given IP from the restricted IPs of the postgresql" }, { "info": { "name": "OVH Cloud Retrieve the most recent postgresql log messages (limited to 1000)", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/logs", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the most recent postgresql log messages (limited to 1000)" }, { "info": { "name": "OVH Cloud List maintenances for the postgresql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/maintenance", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List maintenances for the postgresql cluster" }, { "info": { "name": "OVH Cloud Get the maintenance for the postgresql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/maintenance/:maintenanceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the maintenance for the postgresql cluster" }, { "info": { "name": "OVH Cloud Apply the maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/maintenance/:maintenanceId/apply", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Apply the maintenance" }, { "info": { "name": "OVH Cloud List available metrics for the postgresql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/metric", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "extended", "value": "", "type": "query", "description": "Display DB specific metrics" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available metrics for the postgresql cluster" }, { "info": { "name": "OVH Cloud Get the metric values for the postgresql cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/metric/:metricName", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "metricName", "value": "", "type": "path", "description": "Metric name" }, { "name": "period", "value": "", "type": "query", "description": "The period of time to query metrics for" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the metric values for the postgresql cluster" }, { "info": { "name": "OVH Cloud List nodes of the postgresql", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/node", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List nodes of the postgresql" }, { "info": { "name": "OVH Cloud Get postgresql nodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/node/:nodeId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get postgresql nodes" }, { "info": { "name": "OVH Cloud Retrieve the query statistics for the cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/queryStatistics", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "limit", "value": "", "type": "query", "description": "Limit size of the result set returned by the pagination" }, { "name": "offset", "value": "", "type": "query", "description": "Offset of the result set returned by the pagination" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the query statistics for the cluster" }, { "info": { "name": "OVH Cloud Reset the query statistics of the cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/queryStatistics/reset", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Reset the query statistics of the cluster" }, { "info": { "name": "OVH Cloud Get postgresql roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/roles", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get postgresql roles" }, { "info": { "name": "OVH Cloud List users of the postgresql", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List users of the postgresql" }, { "info": { "name": "OVH Cloud Create a new user on the postgresql cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new user on the postgresql cluster" }, { "info": { "name": "OVH Cloud Get postgresql users", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get postgresql users" }, { "info": { "name": "OVH Cloud Updates the user on the postgresql cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Updates the user on the postgresql cluster" }, { "info": { "name": "OVH Cloud Delete a postgresql user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a postgresql user" }, { "info": { "name": "OVH Cloud Resets the password of a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/postgresql/:clusterId/user/:userId/credentials/reset", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Resets the password of a user" }, { "info": { "name": "OVH Cloud List all the redis of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all the redis of the project" }, { "info": { "name": "OVH Cloud Create a new redis cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new redis cluster" }, { "info": { "name": "OVH Cloud Get redis cluster properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get redis cluster properties" }, { "info": { "name": "OVH Cloud Update an existing redis cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update an existing redis cluster" }, { "info": { "name": "OVH Cloud Delete a redis cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a redis cluster" }, { "info": { "name": "OVH Cloud Get redis advanced configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get redis advanced configuration" }, { "info": { "name": "OVH Cloud Update redis advanced configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update redis advanced configuration" }, { "info": { "name": "OVH Cloud List backups of the redis", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/backup", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List backups of the redis" }, { "info": { "name": "OVH Cloud Get redis backups", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/backup/:backupId", "params": [ { "name": "backupId", "value": "", "type": "path", "description": "Backup ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get redis backups" }, { "info": { "name": "OVH Cloud Get redis advanced configuration fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/capabilities/advancedConfiguration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get redis advanced configuration fields" }, { "info": { "name": "OVH Cloud Get available categories in the redis service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/capabilities/categories", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get available categories in the redis service" }, { "info": { "name": "OVH Cloud Get available commands in the redis service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/capabilities/commands", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get available commands in the redis service" }, { "info": { "name": "OVH Cloud Get integration capabilities related to the redis service", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/capabilities/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get integration capabilities related to the redis service" }, { "info": { "name": "OVH Cloud List integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List integrations" }, { "info": { "name": "OVH Cloud Create a new integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/integration", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new integration" }, { "info": { "name": "OVH Cloud Get an integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get an integration" }, { "info": { "name": "OVH Cloud Delete an integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/integration/:integrationId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an integration" }, { "info": { "name": "OVH Cloud List redis ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List redis ip restrictions" }, { "info": { "name": "OVH Cloud Add ip restrictions to the redis", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/ipRestriction", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add ip restrictions to the redis" }, { "info": { "name": "OVH Cloud Get redis ip restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get redis ip restrictions" }, { "info": { "name": "OVH Cloud Changes the list of ip restrictions to the redis", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Changes the list of ip restrictions to the redis" }, { "info": { "name": "OVH Cloud Deletes the given IP from the restricted IPs of the redis", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/ipRestriction/:ipBlock", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "ipBlock", "value": "", "type": "path", "description": "Ip block" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Deletes the given IP from the restricted IPs of the redis" }, { "info": { "name": "OVH Cloud Retrieve the most recent redis log messages (limited to 1000)", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/logs", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Retrieve the most recent redis log messages (limited to 1000)" }, { "info": { "name": "OVH Cloud List maintenances for the redis cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/maintenance", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List maintenances for the redis cluster" }, { "info": { "name": "OVH Cloud Get the maintenance for the redis cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/maintenance/:maintenanceId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the maintenance for the redis cluster" }, { "info": { "name": "OVH Cloud Apply the maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/maintenance/:maintenanceId/apply", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "maintenanceId", "value": "", "type": "path", "description": "Maintenance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Apply the maintenance" }, { "info": { "name": "OVH Cloud List available metrics for the redis cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/metric", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "extended", "value": "", "type": "query", "description": "Display DB specific metrics" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available metrics for the redis cluster" }, { "info": { "name": "OVH Cloud Get the metric values for the redis cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/metric/:metricName", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "metricName", "value": "", "type": "path", "description": "Metric name" }, { "name": "period", "value": "", "type": "query", "description": "The period of time to query metrics for" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the metric values for the redis cluster" }, { "info": { "name": "OVH Cloud List nodes of the redis", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/node", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List nodes of the redis" }, { "info": { "name": "OVH Cloud Get redis nodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/node/:nodeId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get redis nodes" }, { "info": { "name": "OVH Cloud List users of the redis", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List users of the redis" }, { "info": { "name": "OVH Cloud Create a new user on the redis cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/user", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new user on the redis cluster" }, { "info": { "name": "OVH Cloud Get redis users", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get redis users" }, { "info": { "name": "OVH Cloud Update a user on the redis cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update a user on the redis cluster" }, { "info": { "name": "OVH Cloud Delete a redis user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/user/:userId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a redis user" }, { "info": { "name": "OVH Cloud Resets the password of a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/redis/:clusterId/user/:userId/credentials/reset", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Resets the password of a user" }, { "info": { "name": "OVH Cloud List database services of the project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/service", "params": [ { "name": "category", "value": "", "type": "query", "description": "Category on which restrict the search on services" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List database services of the project" }, { "info": { "name": "OVH Cloud Get service cluster properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/database/service/:clusterId", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get service cluster properties" }, { "info": { "name": "OVH Cloud Get flavors", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/flavor", "params": [ { "name": "region", "value": "", "type": "query", "description": "Flavor region" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get flavors" }, { "info": { "name": "OVH Cloud Get flavor", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/flavor/:flavorId", "params": [ { "name": "flavorId", "value": "", "type": "path", "description": "Flavor ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get flavor" }, { "info": { "name": "OVH Cloud Get images", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/image", "params": [ { "name": "flavorType", "value": "", "type": "query", "description": "Get compatible images with flavor type" }, { "name": "osType", "value": "", "type": "query", "description": "Image OS" }, { "name": "region", "value": "", "type": "query", "description": "Image region" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get images" }, { "info": { "name": "OVH Cloud Get image", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/image/:imageId", "params": [ { "name": "imageId", "value": "", "type": "path", "description": "Image ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get image" }, { "info": { "name": "OVH Cloud Get instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance", "params": [ { "name": "region", "value": "", "type": "query", "description": "Instance region" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get instance" }, { "info": { "name": "OVH Cloud Create a new instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new instance" }, { "info": { "name": "OVH Cloud Create multiple instances", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/bulk", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create multiple instances" }, { "info": { "name": "OVH Cloud Get the detail of a group", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/group", "params": [ { "name": "region", "value": "", "type": "query", "description": "Instance region" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the detail of a group" }, { "info": { "name": "OVH Cloud Create a group", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/group", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a group" }, { "info": { "name": "OVH Cloud Get all groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/group/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "Group ID" }, { "name": "region", "value": "", "type": "query", "description": "Instance region" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get all groups" }, { "info": { "name": "OVH Cloud Delete a group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/group/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "Group ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a group" }, { "info": { "name": "OVH Cloud Get instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get instance" }, { "info": { "name": "OVH Cloud Alter an instance", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Alter an instance" }, { "info": { "name": "OVH Cloud Delete an instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an instance" }, { "info": { "name": "OVH Cloud Activate monthly billing on instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/activeMonthlyBilling", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Activate monthly billing on instance" }, { "info": { "name": "OVH Cloud Return initial credentials of applications installed from public image", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/applicationAccess", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Return initial credentials of applications installed from public image" }, { "info": { "name": "OVH Cloud Get interfaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/interface", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get interfaces" }, { "info": { "name": "OVH Cloud Create interface on an instance and attached it to a network", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/interface", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create interface on an instance and attached it to a network" }, { "info": { "name": "OVH Cloud Get interface", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/interface/:interfaceId", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "interfaceId", "value": "", "type": "path", "description": "Interface ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get interface" }, { "info": { "name": "OVH Cloud Delete an interface", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/interface/:interfaceId", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "interfaceId", "value": "", "type": "path", "description": "Interface ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an interface" }, { "info": { "name": "OVH Cloud Return many statistics about the virtual machine for a given period", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/monitoring", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "period", "value": "", "type": "query", "description": "The period the statistics are fetched for" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "type", "value": "", "type": "query", "description": "The type of statistic to be fetched" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Return many statistics about the virtual machine for a given period" }, { "info": { "name": "OVH Cloud Reboot an instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/reboot", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Reboot an instance" }, { "info": { "name": "OVH Cloud Reinstall an instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/reinstall", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Reinstall an instance" }, { "info": { "name": "OVH Cloud Enable or disable rescue mode", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/rescueMode", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Enable or disable rescue mode" }, { "info": { "name": "OVH Cloud Migrate your instance to another flavor", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/resize", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Migrate your instance to another flavor" }, { "info": { "name": "OVH Cloud Resume a suspended instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/resume", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Resume a suspended instance" }, { "info": { "name": "OVH Cloud Shelve an instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/shelve", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Shelve an instance. The resources dedicated to the Public Cloud instance are released. The data of the local storage will be stored, the duration of the operation depends on the size of the local disk. The instance can be unshelved at any time. Meanwhile hourly instances will not be billed. The Snapshot Storage used to store the instance's data will be billed." }, { "info": { "name": "OVH Cloud Snapshot an instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/snapshot", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Snapshot an instance" }, { "info": { "name": "OVH Cloud Start an instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/start", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Start an instance" }, { "info": { "name": "OVH Cloud Stop an instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/stop", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Stop an instance. The resources dedicated to the Public Cloud instances are still reserved. The instance can be restarted at any time. Meanwhile, the same price is charged for the instance." }, { "info": { "name": "OVH Cloud Unshelve an instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/unshelve", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Unshelve an instance. The resources dedicated to the Public Cloud instance are restored. The duration of the operation depends on the size of the local disk. Instance billing will get back to normal and the snapshot used to store the instance's data will be deleted." }, { "info": { "name": "OVH Cloud Get VNC access to your instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/instance/:instanceId/vnc", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get VNC access to your instance" }, { "info": { "name": "OVH Cloud Get ips", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/ip", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get ips" }, { "info": { "name": "OVH Cloud Get failover ips", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/ip/failover", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get failover ips" }, { "info": { "name": "OVH Cloud Get failover ip", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/ip/failover/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get failover ip" }, { "info": { "name": "OVH Cloud Attach failover ip to an instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/ip/failover/:id/attach", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Attach failover ip to an instance" }, { "info": { "name": "OVH Cloud List your managed Kubernetes clusters", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your managed Kubernetes clusters" }, { "info": { "name": "OVH Cloud Create a new managed Kubernetes cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new managed Kubernetes cluster" }, { "info": { "name": "OVH Cloud List Kubernetes available regions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/regions", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List Kubernetes available regions" }, { "info": { "name": "OVH Cloud Get information about your managed Kubernetes cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get information about your managed Kubernetes cluster" }, { "info": { "name": "OVH Cloud Update information about your managed Kubernetes cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update information about your managed Kubernetes cluster" }, { "info": { "name": "OVH Cloud Delete your managed Kubernetes cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete your managed Kubernetes cluster" }, { "info": { "name": "OVH Cloud Generate a temporary URL to retrieve audit logs", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/auditLogs", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Generate a temporary URL to retrieve audit logs" }, { "info": { "name": "OVH Cloud Get cluster customization", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/customization", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get cluster customization" }, { "info": { "name": "OVH Cloud Update cluster customization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/customization", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update cluster customization" }, { "info": { "name": "OVH Cloud List all flavors available", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/flavors", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all flavors available" }, { "info": { "name": "OVH Cloud List your ip restrictions on your cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/ipRestrictions", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your ip restrictions on your cluster" }, { "info": { "name": "OVH Cloud Append a list of ip restrictions on your cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/ipRestrictions", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Append a list of ip restrictions on your cluster" }, { "info": { "name": "OVH Cloud Remove the current list and add a list of ip restrictions on your cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/ipRestrictions", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Remove the current list and add a list of ip restrictions on your cluster" }, { "info": { "name": "OVH Cloud Delete an ip restriction from your cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/ipRestrictions/:ip", "params": [ { "name": "ip", "value": "", "type": "path", "description": "Ip" }, { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an ip restriction from your cluster" }, { "info": { "name": "OVH Cloud Generate kubeconfig file", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/kubeconfig", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Generate kubeconfig file" }, { "info": { "name": "OVH Cloud Reset kubeconfig: Certificates will be regenerated, nodes will be reinstalled", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/kubeconfig/reset", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Reset kubeconfig: Certificates will be regenerated, nodes will be reinstalled" }, { "info": { "name": "OVH Cloud Generate a temporary URL to retrieve logs", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/log/url", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Generate a temporary URL to retrieve logs" }, { "info": { "name": "OVH Cloud List available metrics for this cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/metrics/etcdUsage", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available metrics for this cluster" }, { "info": { "name": "OVH Cloud List your nodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/node", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your nodes" }, { "info": { "name": "OVH Cloud Get information on a specific node on your cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/node/:nodeId", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get information on a specific node on your cluster" }, { "info": { "name": "OVH Cloud Delete a specific node on your cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/node/:nodeId", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a specific node on your cluster. This will also decrease by one the desirednodes value of its nodepool." }, { "info": { "name": "OVH Cloud List your nodepools", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/nodepool", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your nodepools" }, { "info": { "name": "OVH Cloud Create a nodepool on your cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/nodepool", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a nodepool on your cluster" }, { "info": { "name": "OVH Cloud Get information on a specific nodepool on your cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/nodepool/:nodePoolId", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "nodePoolId", "value": "", "type": "path", "description": "Node pool ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get information on a specific nodepool on your cluster" }, { "info": { "name": "OVH Cloud Update your nodepool information", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/nodepool/:nodePoolId", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "nodePoolId", "value": "", "type": "path", "description": "Node pool ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update your nodepool information" }, { "info": { "name": "OVH Cloud Delete a nodepool from your cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/nodepool/:nodePoolId", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "nodePoolId", "value": "", "type": "path", "description": "Node pool ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a nodepool from your cluster" }, { "info": { "name": "OVH Cloud List all nodes contained in a nodepool", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/nodepool/:nodePoolId/nodes", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "nodePoolId", "value": "", "type": "path", "description": "Node pool ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all nodes contained in a nodepool" }, { "info": { "name": "OVH Cloud Get openIdConnect integration parameters", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/openIdConnect", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get openIdConnect integration parameters" }, { "info": { "name": "OVH Cloud Configure APIServer for OpenIdConnect", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/openIdConnect", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Configure APIServer for OpenIdConnect" }, { "info": { "name": "OVH Cloud Update parameters and reconfigure APIServer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/openIdConnect", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update parameters and reconfigure APIServer" }, { "info": { "name": "OVH Cloud Remove OpenIdConnect integration from APIServer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/openIdConnect", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Remove OpenIdConnect integration from APIServer" }, { "info": { "name": "OVH Cloud Get private network configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/privateNetworkConfiguration", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get private network configuration" }, { "info": { "name": "OVH Cloud Update private network configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/privateNetworkConfiguration", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update private network configuration" }, { "info": { "name": "OVH Cloud Reset cluster: all Kubernetes data will be erased (pods, services, configuration, etc), nodes will be either deleted or reinstalled", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/reset", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Reset cluster: all Kubernetes data will be erased (pods, services, configuration, etc), nodes will be either deleted or reinstalled" }, { "info": { "name": "OVH Cloud Restarting your control plane apiserver to invalidate cache without downtime (using force will create a slight downtime)", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/restart", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Restarting your control plane apiserver to invalidate cache without downtime (using force will create a slight downtime)" }, { "info": { "name": "OVH Cloud Force cluster and node update to the latest patch within minor version or next minor version", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/update", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Force cluster and node update to the latest patch within minor version or next minor version" }, { "info": { "name": "OVH Cloud Updates the load balancers subnet ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/updateLoadBalancersSubnetId", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Updates the load balancers subnet ID" }, { "info": { "name": "OVH Cloud Change the update policy of your cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/kube/:kubeId/updatePolicy", "params": [ { "name": "kubeId", "value": "", "type": "path", "description": "Kube ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Change the update policy of your cluster" }, { "info": { "name": "OVH Cloud List available public cloud labs", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/lab", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List available public cloud labs" }, { "info": { "name": "OVH Cloud Get details of a public cloud lab", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/lab/:labId", "params": [ { "name": "labId", "value": "", "type": "path", "description": "Lab ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get details of a public cloud lab" }, { "info": { "name": "OVH Cloud Activate a lab on your Cloud Project", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/lab/:labId", "params": [ { "name": "labId", "value": "", "type": "path", "description": "Lab ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Activate a lab on your Cloud Project" }, { "info": { "name": "OVH Cloud List required agreements to active this lab", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/lab/:labId/agreement", "params": [ { "name": "labId", "value": "", "type": "path", "description": "Lab ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List required agreements to active this lab" }, { "info": { "name": "OVH Cloud List all load balancer for a tenant", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/loadbalancer", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all load balancer for a tenant" }, { "info": { "name": "OVH Cloud Create a load balancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/loadbalancer", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a load balancer" }, { "info": { "name": "OVH Cloud Get a load balancer", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/loadbalancer/:loadBalancerId", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get a load balancer" }, { "info": { "name": "OVH Cloud Update a load balancer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/loadbalancer/:loadBalancerId", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update a load balancer" }, { "info": { "name": "OVH Cloud Delete a load balancer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/loadbalancer/:loadBalancerId", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a load balancer" }, { "info": { "name": "OVH Cloud List all versions of the configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/loadbalancer/:loadBalancerId/configuration", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List all versions of the configuration" }, { "info": { "name": "OVH Cloud Create a configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/loadbalancer/:loadBalancerId/configuration", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a configuration" }, { "info": { "name": "OVH Cloud Get a configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/loadbalancer/:loadBalancerId/configuration/:version", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "version", "value": "", "type": "path", "description": "Version" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get a configuration" }, { "info": { "name": "OVH Cloud Delete a configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/loadbalancer/:loadBalancerId/configuration/:version", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "version", "value": "", "type": "path", "description": "Version" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a configuration" }, { "info": { "name": "OVH Cloud Apply a configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/loadbalancer/:loadBalancerId/configuration/:version/apply", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "version", "value": "", "type": "path", "description": "Version" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Apply a configuration" }, { "info": { "name": "OVH Cloud Get private networks", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/network/private", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get private networks" }, { "info": { "name": "OVH Cloud Create a new network", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/network/private", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new network" }, { "info": { "name": "OVH Cloud Get private network", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/network/private/:networkId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get private network" }, { "info": { "name": "OVH Cloud Rename private network", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/network/private/:networkId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Rename private network" }, { "info": { "name": "OVH Cloud Delete private network", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/network/private/:networkId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete private network" }, { "info": { "name": "OVH Cloud Activate private network in a new region", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/network/private/:networkId/region", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Activate private network in a new region" }, { "info": { "name": "OVH Cloud Get network subnets", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/network/private/:networkId/subnet", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get network subnets" }, { "info": { "name": "OVH Cloud Create a new network subnet", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/network/private/:networkId/subnet", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new network subnet" }, { "info": { "name": "OVH Cloud Delete a network subnet", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/network/private/:networkId/subnet/:subnetId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "subnetId", "value": "", "type": "path", "description": "Subnet ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a network subnet" }, { "info": { "name": "OVH Cloud Get public networks", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/network/public", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get public networks" }, { "info": { "name": "OVH Cloud List your operations", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/operation", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your operations" }, { "info": { "name": "OVH Cloud Get information about one operation", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/operation/:operationId", "params": [ { "name": "operationId", "value": "", "type": "path", "description": "Operation ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get information about one operation" }, { "info": { "name": "OVH Cloud List quotas", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/quota", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List quotas" }, { "info": { "name": "OVH Cloud List your regions", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your regions" }, { "info": { "name": "OVH Cloud Request access to a region", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Request access to a region" }, { "info": { "name": "OVH Cloud Get information about your region", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get information about your region" }, { "info": { "name": "OVH Cloud Get floating ips", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/floatingip", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get floating ips" }, { "info": { "name": "OVH Cloud Get a floating ip", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/floatingip/:floatingIpId", "params": [ { "name": "floatingIpId", "value": "", "type": "path", "description": "Floating ip ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get a floating ip" }, { "info": { "name": "OVH Cloud Delete a floating ip", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/floatingip/:floatingIpId", "params": [ { "name": "floatingIpId", "value": "", "type": "path", "description": "Floating ip ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a floating ip" }, { "info": { "name": "OVH Cloud Detach your floating ip", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/floatingip/:floatingIpId/detach", "params": [ { "name": "floatingIpId", "value": "", "type": "path", "description": "Floating ip ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Detach your floating ip" }, { "info": { "name": "OVH Cloud List gateways", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/gateway", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "subnetId", "value": "", "type": "query", "description": "Attached interface's subnet id" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List gateways" }, { "info": { "name": "OVH Cloud Create new Gateway and new Private Network with new Subnet", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/gateway", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create new Gateway and new Private Network with new Subnet" }, { "info": { "name": "OVH Cloud Get gateway", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/gateway/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get gateway" }, { "info": { "name": "OVH Cloud Update a gateway", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/gateway/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update a gateway" }, { "info": { "name": "OVH Cloud Delete gateway", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/gateway/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete gateway" }, { "info": { "name": "OVH Cloud Expose gateway to public network by adding a public port on it.", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/gateway/:id/expose", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Expose gateway to public network by adding a public port on it." }, { "info": { "name": "OVH Cloud List interfaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/gateway/:id/interface", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List interfaces" }, { "info": { "name": "OVH Cloud Create gateway interface", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/gateway/:id/interface", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create gateway interface" }, { "info": { "name": "OVH Cloud Get interface", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/gateway/:id/interface/:interfaceId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id" }, { "name": "interfaceId", "value": "", "type": "path", "description": "Interface ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get interface" }, { "info": { "name": "OVH Cloud Delete gateway interface", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/gateway/:id/interface/:interfaceId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id" }, { "name": "interfaceId", "value": "", "type": "path", "description": "Interface ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete gateway interface" }, { "info": { "name": "OVH Cloud Abort an instance snapshot creation", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/instance/:instanceId/abortSnapshot", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Abort an instance snapshot creation" }, { "info": { "name": "OVH Cloud Associate an existing floating IP to an instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/instance/:instanceId/associateFloatingIp", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Associate an existing floating IP to an instance" }, { "info": { "name": "OVH Cloud Create a floating IP and attach it to an instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/instance/:instanceId/floatingIp", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a floating IP and attach it to an instance" }, { "info": { "name": "OVH Cloud List certificates", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/keymanager/certificate", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List certificates" }, { "info": { "name": "OVH Cloud Create a new certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/keymanager/certificate", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new certificate" }, { "info": { "name": "OVH Cloud Get details about a certificate", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/keymanager/certificate/:certificateId", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get details about a certificate" }, { "info": { "name": "OVH Cloud Delete a certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/keymanager/certificate/:certificateId", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a certificate" }, { "info": { "name": "OVH Cloud List secrets", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/keymanager/secret", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List secrets" }, { "info": { "name": "OVH Cloud Get details about a secret", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/keymanager/secret/:secretId", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "secretId", "value": "", "type": "path", "description": "Secret ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get details about a secret" }, { "info": { "name": "OVH Cloud Delete a secret", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/keymanager/secret/:secretId", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "secretId", "value": "", "type": "path", "description": "Secret ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a secret" }, { "info": { "name": "OVH Cloud List flavors", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/flavor", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List flavors" }, { "info": { "name": "OVH Cloud Get details about a load balancing flavor", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/flavor/:flavorId", "params": [ { "name": "flavorId", "value": "", "type": "path", "description": "Flavor ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get details about a load balancing flavor" }, { "info": { "name": "OVH Cloud List health monitors", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/healthMonitor", "params": [ { "name": "poolId", "value": "", "type": "query", "description": "Linked pool id" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List health monitors" }, { "info": { "name": "OVH Cloud Create health monitor", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/healthMonitor", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create health monitor" }, { "info": { "name": "OVH Cloud Get details about a loadbalancer health monitor", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/healthMonitor/:healthMonitorId", "params": [ { "name": "healthMonitorId", "value": "", "type": "path", "description": "Health monitor ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get details about a loadbalancer health monitor" }, { "info": { "name": "OVH Cloud Update a health monitor", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/healthMonitor/:healthMonitorId", "params": [ { "name": "healthMonitorId", "value": "", "type": "path", "description": "Health monitor ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update a health monitor" }, { "info": { "name": "OVH Cloud Delete health monitor", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/healthMonitor/:healthMonitorId", "params": [ { "name": "healthMonitorId", "value": "", "type": "path", "description": "Health monitor ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete health monitor" }, { "info": { "name": "GET /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/l7Policy", "params": [ { "name": "listenerId", "value": "", "type": "query", "description": "Linked listener id" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "POST /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/l7Policy", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "GET /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/l7Policy/:l7PolicyId", "params": [ { "name": "l7PolicyId", "value": "", "type": "path", "description": "L7 policy ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "PUT /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/l7Policy/:l7PolicyId", "params": [ { "name": "l7PolicyId", "value": "", "type": "path", "description": "L7 policy ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "DELETE /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/l7Policy/:l7PolicyId", "params": [ { "name": "l7PolicyId", "value": "", "type": "path", "description": "L7 policy ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "GET /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/l7Policy/:l7PolicyId/l7Rule", "params": [ { "name": "l7PolicyId", "value": "", "type": "path", "description": "L7 policy ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "POST /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/l7Policy/:l7PolicyId/l7Rule", "params": [ { "name": "l7PolicyId", "value": "", "type": "path", "description": "L7 policy ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "GET /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule/{l7RuleId}", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/l7Policy/:l7PolicyId/l7Rule/:l7RuleId", "params": [ { "name": "l7PolicyId", "value": "", "type": "path", "description": "L7 policy ID" }, { "name": "l7RuleId", "value": "", "type": "path", "description": "L7 rule ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "PUT /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule/{l7RuleId}", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/l7Policy/:l7PolicyId/l7Rule/:l7RuleId", "params": [ { "name": "l7PolicyId", "value": "", "type": "path", "description": "L7 policy ID" }, { "name": "l7RuleId", "value": "", "type": "path", "description": "L7 rule ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "DELETE /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule/{l7RuleId}", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/l7Policy/:l7PolicyId/l7Rule/:l7RuleId", "params": [ { "name": "l7PolicyId", "value": "", "type": "path", "description": "L7 policy ID" }, { "name": "l7RuleId", "value": "", "type": "path", "description": "L7 rule ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "OVH Cloud List your loadbalancer listeners", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/listener", "params": [ { "name": "loadbalancerId", "value": "", "type": "query", "description": "Filter by loadbalancer" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your loadbalancer listeners" }, { "info": { "name": "OVH Cloud Create a loadbalancer listener", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/listener", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a loadbalancer listener" }, { "info": { "name": "OVH Cloud Get details about a loadbalancer listener", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/listener/:listenerId", "params": [ { "name": "listenerId", "value": "", "type": "path", "description": "Listener ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get details about a loadbalancer listener" }, { "info": { "name": "OVH Cloud Edit a loadbalancer listener", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/listener/:listenerId", "params": [ { "name": "listenerId", "value": "", "type": "path", "description": "Listener ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Edit a loadbalancer listener" }, { "info": { "name": "OVH Cloud Delete loadbalancer listener", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/listener/:listenerId", "params": [ { "name": "listenerId", "value": "", "type": "path", "description": "Listener ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete loadbalancer listener" }, { "info": { "name": "OVH Cloud List your load balancers", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/loadbalancer", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your load balancers" }, { "info": { "name": "OVH Cloud Create a loadbalancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/loadbalancer", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a loadbalancer" }, { "info": { "name": "OVH Cloud Get details about a load balancer", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/loadbalancer/:loadBalancerId", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get details about a load balancer" }, { "info": { "name": "OVH Cloud Edit a loadbalancer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/loadbalancer/:loadBalancerId", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Edit a loadbalancer" }, { "info": { "name": "OVH Cloud Delete loadbalancer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/loadbalancer/:loadBalancerId", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete loadbalancer" }, { "info": { "name": "OVH Cloud Associate an existing floating IP to a loadbalancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/loadbalancer/:loadBalancerId/associateFloatingIp", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Associate an existing floating IP to a loadbalancer" }, { "info": { "name": "OVH Cloud Create a floating IP and attach it to a loadbalancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/loadbalancer/:loadBalancerId/floatingIp", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a floating IP and attach it to a loadbalancer" }, { "info": { "name": "OVH Cloud Get loadbalancer statistics", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/loadbalancer/:loadBalancerId/stats", "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "Load balancer ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get loadbalancer statistics" }, { "info": { "name": "OVH Cloud List your loadbalancer pools", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/pool", "params": [ { "name": "loadbalancerId", "value": "", "type": "query", "description": "Filter by loadbalancer" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your loadbalancer pools" }, { "info": { "name": "OVH Cloud Create a loadbalancer pool", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/pool", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a loadbalancer pool" }, { "info": { "name": "OVH Cloud Get details about a loadbalancer pool", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/pool/:poolId", "params": [ { "name": "poolId", "value": "", "type": "path", "description": "Pool ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get details about a loadbalancer pool" }, { "info": { "name": "OVH Cloud Update a loadbalancer pool", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/pool/:poolId", "params": [ { "name": "poolId", "value": "", "type": "path", "description": "Pool ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update a loadbalancer pool" }, { "info": { "name": "OVH Cloud Delete a loadbalancer pool", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/pool/:poolId", "params": [ { "name": "poolId", "value": "", "type": "path", "description": "Pool ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a loadbalancer pool" }, { "info": { "name": "OVH Cloud List your pool members", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/pool/:poolId/member", "params": [ { "name": "poolId", "value": "", "type": "path", "description": "Pool ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your pool members" }, { "info": { "name": "OVH Cloud Create pool members", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/pool/:poolId/member", "params": [ { "name": "poolId", "value": "", "type": "path", "description": "Pool ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create pool members" }, { "info": { "name": "OVH Cloud Get details about a pool member", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/pool/:poolId/member/:memberId", "params": [ { "name": "memberId", "value": "", "type": "path", "description": "Member ID" }, { "name": "poolId", "value": "", "type": "path", "description": "Pool ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get details about a pool member" }, { "info": { "name": "OVH Cloud Update a pool member", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/pool/:poolId/member/:memberId", "params": [ { "name": "memberId", "value": "", "type": "path", "description": "Member ID" }, { "name": "poolId", "value": "", "type": "path", "description": "Pool ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update a pool member" }, { "info": { "name": "OVH Cloud Delete a pool member", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/loadbalancing/pool/:poolId/member/:memberId", "params": [ { "name": "memberId", "value": "", "type": "path", "description": "Member ID" }, { "name": "poolId", "value": "", "type": "path", "description": "Pool ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a pool member" }, { "info": { "name": "OVH Cloud List networks", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/network", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List networks" }, { "info": { "name": "OVH Cloud Create a network with a gateway", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/network", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a network with a gateway" }, { "info": { "name": "OVH Cloud Get network", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/network/:networkId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get network" }, { "info": { "name": "OVH Cloud Delete network", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/network/:networkId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete network" }, { "info": { "name": "OVH Cloud List subnets", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/network/:networkId/subnet", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List subnets" }, { "info": { "name": "OVH Cloud Get subnet", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/network/:networkId/subnet/:subnetId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "subnetId", "value": "", "type": "path", "description": "Subnet ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get subnet" }, { "info": { "name": "OVH Cloud Delete subnet", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/network/:networkId/subnet/:subnetId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "subnetId", "value": "", "type": "path", "description": "Subnet ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete subnet" }, { "info": { "name": "OVH Cloud Create Gateway for existing subnet", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/network/:networkId/subnet/:subnetId/gateway", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "subnetId", "value": "", "type": "path", "description": "Subnet ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create Gateway for existing subnet" }, { "info": { "name": "OVH Cloud List quotas", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/quota", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List quotas" }, { "info": { "name": "OVH Cloud Change project quotas on region", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/quota", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Change project quotas on region" }, { "info": { "name": "OVH Cloud Get allowed quotas on region", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/quota/allowed", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get allowed quotas on region" }, { "info": { "name": "OVH Cloud Get storage quotas on region", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/quota/storage", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get storage quotas on region" }, { "info": { "name": "OVH Cloud Update storage quota on region", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/quota/storage", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update storage quota on region" }, { "info": { "name": "OVH Cloud Delete storage quota on region", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/quota/storage", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete storage quota on region" }, { "info": { "name": "OVH Cloud Get S3 storage containers", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/storage", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get S3 storage containers" }, { "info": { "name": "OVH Cloud Create S3 storage container", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/storage", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create S3 storage container" }, { "info": { "name": "OVH Cloud Get S3 storage container", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/storage/:name", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Limit the number of objects returned (1000 maximum, defaults to 1000)" }, { "name": "marker", "value": "", "type": "query", "description": "List objects whose names are greater than marker" }, { "name": "name", "value": "", "type": "path", "description": "Name" }, { "name": "prefix", "value": "", "type": "query", "description": "Filter objects by name prefix" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get S3 storage container" }, { "info": { "name": "OVH Cloud Update S3 storage container", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/storage/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update S3 storage container" }, { "info": { "name": "OVH Cloud Delete S3 storage container", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/storage/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete S3 storage container" }, { "info": { "name": "OVH Cloud Delete S3 storage container object", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/storage/:name/object/:objectKey", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name" }, { "name": "objectKey", "value": "", "type": "path", "description": "Object key" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete S3 storage container object" }, { "info": { "name": "OVH Cloud Add S3 storage container policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/storage/:name/policy/:userId", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add S3 storage container policy" }, { "info": { "name": "OVH Cloud Generate S3 presigned URLs to download or upload objects", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/storage/:name/presign", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Generate S3 presigned URLs to download or upload objects" }, { "info": { "name": "OVH Cloud List volume backups", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/volumeBackup", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List volume backups" }, { "info": { "name": "OVH Cloud Create a volume backup", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/volumeBackup", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a volume backup" }, { "info": { "name": "OVH Cloud Get volume backup", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/volumeBackup/:volumeBackupId", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "volumeBackupId", "value": "", "type": "path", "description": "Volume backup ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get volume backup" }, { "info": { "name": "OVH Cloud Delete volume backup", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/volumeBackup/:volumeBackupId", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "volumeBackupId", "value": "", "type": "path", "description": "Volume backup ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete volume backup" }, { "info": { "name": "OVH Cloud Restore a volume backup on a volume", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/volumeBackup/:volumeBackupId/restore", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "volumeBackupId", "value": "", "type": "path", "description": "Volume backup ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Restore a volume backup on a volume" }, { "info": { "name": "OVH Cloud Create a volume from a volume backup", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/volumeBackup/:volumeBackupId/volume", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "volumeBackupId", "value": "", "type": "path", "description": "Volume backup ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a volume from a volume backup" }, { "info": { "name": "OVH Cloud List your automated backups", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/workflow/backup", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your automated backups" }, { "info": { "name": "OVH Cloud Create a new automated backup", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/workflow/backup", "params": [ { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new automated backup" }, { "info": { "name": "OVH Cloud Get details about a backup workflow process", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/workflow/backup/:backupWorkflowId", "params": [ { "name": "backupWorkflowId", "value": "", "type": "path", "description": "Backup workflow ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get details about a backup workflow process" }, { "info": { "name": "OVH Cloud Delete a backup workflow process", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/region/:regionName/workflow/backup/:backupWorkflowId", "params": [ { "name": "backupWorkflowId", "value": "", "type": "path", "description": "Backup workflow ID" }, { "name": "regionName", "value": "", "type": "path", "description": "Region name" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a backup workflow process" }, { "info": { "name": "OVH Cloud List the regions on which you can ask an access to", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/regionAvailable", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List the regions on which you can ask an access to" }, { "info": { "name": "OVH Cloud Get all Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/role", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get all Roles" }, { "info": { "name": "OVH Cloud Get service information", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/serviceInfos", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "The project id" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get service information" }, { "info": { "name": "OVH Cloud Update service information", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/serviceInfos", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "The project id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update service information" }, { "info": { "name": "OVH Cloud Get snapshots", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/snapshot", "params": [ { "name": "flavorType", "value": "", "type": "query", "description": "Get compatible snapshots with flavor type" }, { "name": "region", "value": "", "type": "query", "description": "Region" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get snapshots" }, { "info": { "name": "OVH Cloud Get snapshot details", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/snapshot/:imageId", "params": [ { "name": "imageId", "value": "", "type": "path", "description": "Image ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get snapshot details" }, { "info": { "name": "OVH Cloud Delete a snapshot", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/snapshot/:imageId", "params": [ { "name": "imageId", "value": "", "type": "path", "description": "Image ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a snapshot" }, { "info": { "name": "OVH Cloud Get SSH keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/sshkey", "params": [ { "name": "region", "value": "", "type": "query", "description": "Region" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get SSH keys" }, { "info": { "name": "OVH Cloud Create SSH key", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/sshkey", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create SSH key" }, { "info": { "name": "OVH Cloud Get SSH key", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/sshkey/:keyId", "params": [ { "name": "keyId", "value": "", "type": "path", "description": "Key ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get SSH key" }, { "info": { "name": "OVH Cloud Delete SSH key", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/sshkey/:keyId", "params": [ { "name": "keyId", "value": "", "type": "path", "description": "Key ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete SSH key" }, { "info": { "name": "OVH Cloud Get stacks", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/stack", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get stacks" }, { "info": { "name": "OVH Cloud Get stack", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/stack/:stackId", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "stackId", "value": "", "type": "path", "description": "Stack ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get stack" }, { "info": { "name": "OVH Cloud Get SWIFT storage containers", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/storage", "params": [ { "name": "includeType", "value": "", "type": "query", "description": "Include container type" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get SWIFT storage containers" }, { "info": { "name": "OVH Cloud Create SWIFT container", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/storage", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create SWIFT container" }, { "info": { "name": "OVH Cloud Access to SWIFT storage API", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/storage/access", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Access to SWIFT storage API" }, { "info": { "name": "OVH Cloud List storage quotas", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/storage/quota", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List storage quotas" }, { "info": { "name": "OVH Cloud Get SWIFT storage container", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/storage/:containerId", "params": [ { "name": "containerId", "value": "", "type": "path", "description": "Container ID" }, { "name": "noObjects", "value": "", "type": "query", "description": "Do not return container objects" }, { "name": "prefix", "value": "", "type": "query", "description": "Filter objects by name prefix" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get SWIFT storage container" }, { "info": { "name": "OVH Cloud Update SWIFT storage container", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/storage/:containerId", "params": [ { "name": "containerId", "value": "", "type": "path", "description": "Container ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update SWIFT storage container" }, { "info": { "name": "OVH Cloud Delete SWIFT container", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/storage/:containerId", "params": [ { "name": "containerId", "value": "", "type": "path", "description": "Container ID" }, { "name": "recursive", "value": "", "type": "query", "description": "Recursively delete objects and container" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete SWIFT container" }, { "info": { "name": "OVH Cloud Add CORS support on SWIFT container", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/storage/:containerId/cors", "params": [ { "name": "containerId", "value": "", "type": "path", "description": "Container ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add CORS support on SWIFT container" }, { "info": { "name": "OVH Cloud Delete CORS support on SWIFT container", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/storage/:containerId/cors", "params": [ { "name": "containerId", "value": "", "type": "path", "description": "Container ID" }, { "name": "origin", "value": "", "type": "query", "description": "Delete this origin" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete CORS support on SWIFT container" }, { "info": { "name": "OVH Cloud Get a public temporary URL to access one of your SWIFT object", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/storage/:containerId/publicUrl", "params": [ { "name": "containerId", "value": "", "type": "path", "description": "Container ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get a public temporary URL to access one of your SWIFT object" }, { "info": { "name": "OVH Cloud Deploy your SWIFT container files as a static web site", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/storage/:containerId/static", "params": [ { "name": "containerId", "value": "", "type": "path", "description": "Container ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Deploy your SWIFT container files as a static web site" }, { "info": { "name": "OVH Cloud Create openstack user with only access to this SWIFT container", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/storage/:containerId/user", "params": [ { "name": "containerId", "value": "", "type": "path", "description": "Container ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create openstack user with only access to this SWIFT container" }, { "info": { "name": "OVH Cloud Ask for the termination of your service", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/terminate", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "The project id" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Ask for the termination of your service. Admin contact of this service will receive a termination token by email in order to confirm its termination with /confirmTermination endpoint." }, { "info": { "name": "OVH Cloud Get all users", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get all users" }, { "info": { "name": "OVH Cloud Create user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create user" }, { "info": { "name": "OVH Cloud Get user details", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get user details" }, { "info": { "name": "OVH Cloud Delete user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete user" }, { "info": { "name": "OVH Cloud Get your client configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/configuration", "params": [ { "name": "region", "value": "", "type": "query", "description": "Region" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get your client configuration" }, { "info": { "name": "OVH Cloud Get RC file of OpenStack", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/openrc", "params": [ { "name": "region", "value": "", "type": "query", "description": "Region" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" }, { "name": "version", "value": "", "type": "query", "description": "Identity API version" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get RC file of OpenStack" }, { "info": { "name": "OVH Cloud Export user storage policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/policy", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Export user storage policy" }, { "info": { "name": "OVH Cloud Import user storage policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/policy", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Import user storage policy" }, { "info": { "name": "OVH Cloud Get rclone configuration file", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/rclone", "params": [ { "name": "region", "value": "", "type": "query", "description": "Region" }, { "name": "service", "value": "", "type": "query", "description": "Service" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get rclone configuration file" }, { "info": { "name": "OVH Cloud Regenerate user password", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/regeneratePassword", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Regenerate user password" }, { "info": { "name": "OVH Cloud Get user roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/role", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get user roles" }, { "info": { "name": "OVH Cloud Add a role to a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/role", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Add a role to a user" }, { "info": { "name": "OVH Cloud Update roles of a user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/role", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update roles of a user" }, { "info": { "name": "OVH Cloud Get role detail", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/role/:roleId", "params": [ { "name": "roleId", "value": "", "type": "path", "description": "Role ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get role detail" }, { "info": { "name": "OVH Cloud Remove role for a user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/role/:roleId", "params": [ { "name": "roleId", "value": "", "type": "path", "description": "Role ID" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Remove role for a user" }, { "info": { "name": "OVH Cloud List your S3 credentials", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/s3Credentials", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud List your S3 credentials" }, { "info": { "name": "OVH Cloud Create a new S3 credentials for an user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/s3Credentials", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a new S3 credentials for an user" }, { "info": { "name": "OVH Cloud Get details about an S3 credential", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/s3Credentials/:access", "params": [ { "name": "access", "value": "", "type": "path", "description": "Access" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get details about an S3 credential" }, { "info": { "name": "OVH Cloud Delete an S3 credential", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/s3Credentials/:access", "params": [ { "name": "access", "value": "", "type": "path", "description": "Access" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete an S3 credential" }, { "info": { "name": "OVH Cloud Display secret from a S3 credential", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/s3Credentials/:access/secret", "params": [ { "name": "access", "value": "", "type": "path", "description": "Access" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Display secret from a S3 credential" }, { "info": { "name": "OVH Cloud Get token for user", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/user/:userId/token", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get token for user" }, { "info": { "name": "OVH Cloud Get volumes", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/volume", "params": [ { "name": "region", "value": "", "type": "query", "description": "Volume region" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get volumes" }, { "info": { "name": "OVH Cloud Create a volume", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/volume", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Create a volume" }, { "info": { "name": "OVH Cloud Get volume snapshots", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/volume/snapshot", "params": [ { "name": "region", "value": "", "type": "query", "description": "Snapshots region" }, { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get volume snapshots" }, { "info": { "name": "OVH Cloud Get volume snapshot details", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/volume/snapshot/:snapshotId", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "snapshotId", "value": "", "type": "path", "description": "Snapshot ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get volume snapshot details" }, { "info": { "name": "OVH Cloud Delete a volume snapshot", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/volume/snapshot/:snapshotId", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "snapshotId", "value": "", "type": "path", "description": "Snapshot ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a volume snapshot" }, { "info": { "name": "OVH Cloud Get volume details", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/volume/:volumeId", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "volumeId", "value": "", "type": "path", "description": "Volume ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get volume details" }, { "info": { "name": "OVH Cloud Update a volume", "type": "http" }, "http": { "method": "PUT", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/volume/:volumeId", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "volumeId", "value": "", "type": "path", "description": "Volume ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Update a volume" }, { "info": { "name": "OVH Cloud Delete a volume", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/volume/:volumeId", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "volumeId", "value": "", "type": "path", "description": "Volume ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Delete a volume" }, { "info": { "name": "OVH Cloud Attach a volume on an instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/volume/:volumeId/attach", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "volumeId", "value": "", "type": "path", "description": "Volume ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Attach a volume on an instance" }, { "info": { "name": "OVH Cloud Detach a volume from an instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/volume/:volumeId/detach", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "volumeId", "value": "", "type": "path", "description": "Volume ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Detach a volume from an instance" }, { "info": { "name": "OVH Cloud Snapshot a volume", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/volume/:volumeId/snapshot", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "volumeId", "value": "", "type": "path", "description": "Volume ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Snapshot a volume" }, { "info": { "name": "OVH Cloud Extend a volume", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/volume/:volumeId/upsize", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" }, { "name": "volumeId", "value": "", "type": "path", "description": "Volume ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Extend a volume" }, { "info": { "name": "OVH Cloud Get the linked vRack on your project", "type": "http" }, "http": { "method": "GET", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/vrack", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Get the linked vRack on your project" }, { "info": { "name": "OVH Cloud Order and attach a new vRack on your project", "type": "http" }, "http": { "method": "POST", "url": "https://api.us.ovhcloud.com/v1/cloud/project/:serviceName/vrack", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://us.ovhcloud.com/auth/oauth2/authorize", "accessTokenUrl": "https://us.ovhcloud.com/auth/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "OVH Cloud Order and attach a new vRack on your project" } ] } ], "bundled": true }